4cd0e9c303bb97128ad71a8e236602ca0fbcadae gperez2 Tue Jun 11 16:27:00 2024 -0700 Adding 'Labeling tracks with informative labels will help users.' to publicHubGuidelines.html per user request, refs #33768 diff --git src/hg/htdocs/goldenPath/help/publicHubGuidelines.html src/hg/htdocs/goldenPath/help/publicHubGuidelines.html index 3b562e6..58a4879 100755 --- src/hg/htdocs/goldenPath/help/publicHubGuidelines.html +++ src/hg/htdocs/goldenPath/help/publicHubGuidelines.html @@ -87,32 +87,33 @@ <a id="stability"></a> <p><b style="color: red;">Note on stability</b></p> <p> Keep in mind that users may start to rely on your track hub for their work. If the track hub web server is down or the URL changes, users of the track hub will have no access to the data. Users may also have stable session links in manuscripts that include the track hub data and the sessions could all stop working. We check public track hubs periodically and send an email after a 24-hour downtime. We will remove track hubs if they are offline for several days. Contact us (genome-www@soe.ucsc.edu) if there is a change such as moving webservers of the track hub. </p> <p> Sudden changes can also impact users where large changes to the track hub can change the analysis of users such as removing tracks or changing options. In these cases, keeping a previous version of the tracks and making them in a different track group with suffixes such as "V1", -"(previous versions)" or hint in the track long labels will help users. You can also add a -"dataVersion" trackDb statement to indicate to users what version of the data is being used. +"(previous versions)" or hint in the track long labels. Labeling tracks with informative +labels will help users. You can also add a "dataVersion" trackDb statement to indicate to +users what version of the data is being used. </p> <h3>Track organization recommendations</h3> <p> Related tracks can be grouped in a few different ways, namely <a href="trackDb/trackDbHub.html#superTrack" target="_blank">superTracks</a>, <a href="trackDb/trackDbHub.html#aggregate" target="_blank">multiWigs</a>, and <a href="trackDb/trackDbHub.html#compositeTrack" target="_blank">composites</a>. If your hub includes a large number of tracks, the grouping of tracks may be necessary. This will prevent your hub's track group from being an overwhelming mess of individual tracks and can make user configuration of your tracks easier.</p> <h6>Composite tracks</h6> <p> Related tracks of the same data type (e.g. a set of related bigBed tracks) should be combined into <a href="trackDb/trackDbHub.html#compositeTrack" target="_blank">composites</a> where