Versioned Track Hubs: Difference between revisions
From Genecats
Jump to navigationJump to search
| Line 4: | Line 4: | ||
<h1> How to work with the 'versioned' track hub settings | <h1> How to work with the 'versioned' track hub settings | ||
</h1> | </h1> | ||
<h5>1) Since every trackDb setting in the doc is now assigned a level (described in the intro of the trackDbHub doc)... | <h5>1) Since every trackDb setting in the doc is now assigned a level (described in the [http://genome.ucsc.edu/goldenPath/help/trackDb/trackDbHub.html intro of the trackDbHub doc])... | ||
</h5> | </h5> | ||
<h3>-> When you add a new setting, you will need to set it to 'level-new'. | ::<h3>-> When you add a new setting, you will need to set it to 'level-new'. | ||
</h3> | </h3> | ||
Next time the doc is versioned, we will evaluate the new settings for assignment to a level. | Next time the doc is versioned, we will evaluate the new settings for assignment to a level. | ||
<h5>2) As the doc is now parsed by hubCheck to verify settings... | <h5>2) As the doc is now parsed by hubCheck to verify settings... | ||
</h5> | </h5> | ||
<h3> | ::<h3>-> After adding a setting to the doc, you will need to run <code>hubCheck -settings</code> to see if your addition is formatted correctly. | ||
-> After adding a setting to the doc, you will need to run | |||
</h3> | </h3> | ||
To list all | To list all settings (with levels) on genome-test, run | ||
::<code>hubCheck -settings -test</code> | |||
<br> | <br> | ||
The '''README.txt''' in the trackDb docs dir has been extended to include these steps with the new information in step 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> | |||
<code>$ cat ~kent/src/hg/htdocs/goldenPath/help/trackDb/README.txt </code> | |||
Also see the long comment at the top of trackDbLibrary.shtml for details | Also see the long comment at the top of trackDbLibrary.shtml for details | ||
<p> | |||
<code>head -n 125 ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml</code> | <code>head -n 125 ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml</code> | ||
Revision as of 23:04, 21 August 2015
Overview
This page exists as a reminder to engineers on how to approach the new versioned track hub documentation.
How to work with the 'versioned' track hub settings
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 -settingsto see if your addition is formatted correctly.
To list all 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
