Data Hub Feedback: Difference between revisions
From Genecats
Jump to navigationJump to search
(Created page with "In August of 2011, we released the new Data Hub feature. In order to gather feedback from users, we created a survey. From mid-November 2011 through mid-January 2012, we provided...") |
(temporary Hub steps) |
||
| Line 1: | Line 1: | ||
In August of 2011, we released the new Data Hub feature. In order to gather feedback from users, we created a survey. From mid-November 2011 through mid-January 2012, we provided a link from the hgHubConnect CGI on the RR to that survey. 22 users answered. Their answers are in this file: [[File:DataHubSurvey2011.pdf]]. | In August of 2011, we released the new Data Hub feature. In order to gather feedback from users, we created a survey. From mid-November 2011 through mid-January 2012, we provided a link from the hgHubConnect CGI on the RR to that survey. 22 users answered. Their answers are in this file: [[File:DataHubSurvey2011.pdf]]. | ||
------this is temporarily sitting here and can be removed later | |||
<h1> How to work with the 'versioned' track hub settings | |||
</h1> | |||
What these mean for engineers: | |||
<h5>1) Since every trackDb setting in the doc is now assigned a level (described in the intro of the trackDbHub doc)... | |||
</h5> | |||
<h3>-> When you add a new setting, you will need to set it to 'level-new'. | |||
</h3> | |||
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> | |||
<h3> | |||
-> After adding a setting to the doc, you will need to run 'hubCheck -settings' to see if your addition is formatted correctly. | |||
</h3> | |||
To list all v1 settings (with levels) on genome-test, run | |||
::::::<code>hubCheck -settings -test</code> | |||
<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. | |||
------------------------------- | |||
$ 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 | |||
Latest revision as of 20:21, 21 August 2015
In August of 2011, we released the new Data Hub feature. In order to gather feedback from users, we created a survey. From mid-November 2011 through mid-January 2012, we provided a link from the hgHubConnect CGI on the RR to that survey. 22 users answered. Their answers are in this file: File:DataHubSurvey2011.pdf.
this is temporarily sitting here and can be removed later
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 (and below) has been extended to include these steps. The new bits are in item #3.
$ cat ~kent/src/hg/htdocs/goldenPath/help/trackDb/README.txt
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 detailshead -n 125 ~kent/src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml
