61547c79190553a311776b9a309bcb5dafada237 gperez2 Mon Jul 1 01:23:58 2024 -0700 Adding documentation on adding groups to a Track Hub, refs #33580 diff --git src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html index 429be55..0cd7e0f 100755 --- src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html +++ src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html @@ -2,30 +2,31 @@
Additional resources
Hubs can be loaded into the URL using the hubUrl=
parameter. This parameter
takes input similar to the track hub input box.
Native UCSC supported genomes can be loaded into the URL using the db=
parameter while
non-natively supported genomes such as assembly hubs or GenArk hubs use the genome=
parameter. URL parameters can be combined by using &
.
The following example links to the hg19 genome database and an example track hub using the db=
and the hubUrl=
parameters:
http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg19&hubUrl=https://genome.ucsc.edu/goldenPath/help/examples/hubDirectory/hub.txt+
http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg19&hubUrl=https://genome.ucsc.edu/goldenPath/help/examples/hubDirectory/hub.txt
Track hubs' track visibility can also be changed from the URL parameters. As an example, the following link specifies:
https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hubUrl=http://hgdownload.soe.ucsc.edu/hubs/gtex/hub.txt&hideTracks=1>exRnaSignalMaleYoung_hideKids=1>exRnaSignalMaleYoung=full>exRnaSignalSRR1311243=full&ignoreCookie=1+
https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hubUrl=http://hgdownload.soe.ucsc.edu/hubs/gtex/hub.txt&hideTracks=1>exRnaSignalMaleYoung_hideKids=1>exRnaSignalMaleYoung=full>exRnaSignalSRR1311243=full&ignoreCookie=1
guidelines=on/off
- activate or deactivate the blue guidelineshgFind.matches=<listOfNames>
- highlight features given their nameshgt.reset=1
- show only the default trackshgt.toggleRevCmplDisp=1
- show the reverse-complementhgt.labelWidth=<number>
- set the size of the left-side label areahideTracks=1
- hide all trackshideTracks=1&<trackName>=full|dense|pack|hide
- hide all tracks and show
other trackshighlight=<db>.<chrom>:<chromStart>-<chromEnd>#<color>|...
The track description file must have the same name as the symbolic name for the track (defined by the track tag in the trackDb.txt file) with a suffix of .html. For instance, a description file associated with the track named "dnaseSignal" in Example 4 would be named "dnaseSignal.html". The description file must reside in the same directory as the trackDb.txt file.
Both parent and child tracks within a super-track can have their own description files. If the description file is not present, the corresponding sections of the track settings and details pages are left blank. Only one description page can be associated with composite and multiWig tracks; the file name should correspond to the symbolic name of the top-level track in the composite.
+ + +You can add groups to your track hub by using the groups setting, which points to a separate +text document that defines the track groups under the primary genome browser image display. As an +example using the +EPD Viewer Hub, +here is how the track hub displays without the groups setting:
+Groups such as Histone, CAGE, RAMPAGE, and Fantom5 groups can be added. The text document that +defines the track groups can be named groups.txt and specifies the groups such as the following: +
+name histone
+label Histone
+priority 1
+defaultIsClosed 0
+
+name cage
+label CAGE
+priority 2
+defaultIsClosed 0
+
+name rampage
+label RAMPAGE
+priority 3
+defaultIsClosed 0
+
+name fantom5
+label Fantom5
+priority 4
+defaultIsClosed 0
+
+You would then add the group name to your tracks in the trackDb stanza. For example, adding the +Histone Marks track to the Histone group:
+
track 1histone
+type bigWig
+longLabel Selected Histone Marks
+autoScale on
+smoothingWindow 10
+priority 1
+compositeTrack on
+allButtonPair on
+windowingFunction mean
+shortLabel Histone Marks
+visibility full
+group histone
+
+The groups.txt file then needs to be added to the genome stanza. The genome can be a UCSC genome or an assembly hub. The hg38 genome will be used as an example: +
genome hg38
+trackDb hg38/trackDb.txt
+groups groups.txt
+
+Attaching the EPD Viewer Hub with these group settings will then display the tracks within +the groups:
+As part of the track hub mechanism, UCSC caches data from the hub on the local server. The hub utility periodically checks the time stamps on the hub files, and downloads them again only if they have a time stamp newer than the UCSC one. For performance reasons, UCSC checks the time stamps every 300 seconds, which can result in a 5-minute delay between the time a hub file is updated and the change appears on the Genome Browser. Hub providers can work around this delay by inserting the CGI variable udcTimeout=5 into the Genome Browser URL, which will reduce the delay to five seconds. To add this variable, open the Genome Browser tracks page and zoom or scroll the image to display a full browser URL in which the CGI variables visible. Insert the CGI variable just after the "hgTracks" portion of the URL so that it reads