Versioned Track Hubs: Difference between revisions

From Genecats
Jump to navigationJump to search
(Adding page about version additions.)
 
Line 1: Line 1:
==Overview==
This page exists to help capture the process change when editing Track Hubs.
<h1> How to work with the 'versioned' track hub settings
<h1> How to work with the 'versioned' track hub settings
</h1>
</h1>
Line 20: Line 16:


<br>
<br>
The '''README.txt''' in the trackDb docs dir (and below) has been extended to include these steps. The new bits are in item #3.
The '''README.txt''' in the trackDb docs dir has been extended to include these steps with the new information in step 3.
 
<code>$ cat ~kent/src/hg/htdocs/goldenPath/help/trackDb/README.txt</code>
-------------------------------
$ cat ~kent/src/hg/htdocs/goldenPath/help/trackDb/README.txt  
<pre>
To add a new statement to the trackDb documentation:
 
1. Add your statement documentation to trackDbLibrary.shtml
 
2. Add references to your statement to trackDbDoc.html
 
3. If intended for hubs:
* Add to the latest trackDbHub doc (e.g. trackDbHub.v1.html), with support level 'new'.
(see intro of the doc for explanation of support levels).
* Use hubCheck to verify the doc entry is properly formatted:
% make
% hubCheck -settings \
-version=http://hgwdev-<user>/goldenPath/help/trackDb/trackDbHub.v1.html
OR
% make alpha
% hubCheck -settings -test
 
- See the long comment at the top of trackDbLibrary.shtml for details
<pre>


head -n 125  ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml
Also see the long comment at the top of trackDbLibrary.shtml for details
<code>head -n 125  ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml</code>

Revision as of 22:58, 21 August 2015

How to work with the 'versioned' track hub settings

What these mean for engineers:

1) Since every trackDb setting in the doc is now assigned a level (described in the intro of the trackDbHub doc)...

-> When you add a new setting, you will need to set it to 'level-new'.

Next time the doc is versioned, we will evaluate the new settings for assignment to a level.

2) As the doc is now parsed by hubCheck to verify settings...

-> After adding a setting to the doc, you will need to run 'hubCheck -settings' to see if your addition is formatted correctly.

To list all v1 settings (with levels) on genome-test, run

hubCheck -settings -test


The README.txt in the trackDb docs dir has been extended to include these steps with the new information in step 3. $ cat ~kent/src/hg/htdocs/goldenPath/help/trackDb/README.txt

Also see the long comment at the top of trackDbLibrary.shtml for details head -n 125 ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml