8555ec47e45208a9e8a9466cae97238fade7699a gperez2 Thu Mar 28 11:56:22 2024 -0700 Updating the Sharing Track Hubs section for hgTrackHubHelp.html, refs #21107 diff --git src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html index 4a35fc3..06588c7 100755 --- src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html +++ src/hg/htdocs/goldenPath/help/hgTrackHubHelp.html @@ -177,46 +177,206 @@ of being single-click access and sharing a full browser configuration. If you are just starting, an overview of the process is to make the hub on your web-accessible server, attach the hub to the Genome Browser, configure browser position and related tracks, then save your named session and share the session link. Your session links will be in the following format with your chosen username and session name:

For additional information, see sharing Saved Sessions and backing up custom data.

-

-If you prefer URL manipulation, it is also possible to add or -share a track hub directly by URL -or otherwise modify the browser via URL. For example, if you add -hubUrl=[URL] to your hgTracks URL line, it will add the hub -directly into the browser:

+ + + + + +

Creating a URL for a Track Hub

+

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
+ +

Track hubs' track visibility can also be changed from the URL parameters. As an example, the +following link specifies:

+
  • the genome database (db=hg38)
  • +
  • loads a track hub (hubUrl=http://hgdownload.soe.ucsc.edu/hubs/gtex/hub.txt)
  • +
  • hides all tracks (hideTracks=1)
  • +
  • hides the subtrack kids of a particular track (gtexRnaSignalMaleYoung_hideKids=1)
  • +
  • sets a specific subtrack to be displayed (gtexRnaSignalSRR1311243=full)
  • +
  • ignores user settings (ignoreCookie=1).

  • + +
    https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hubUrl=http://hgdownload.soe.ucsc.edu/hubs/gtex/hub.txt&hideTracks=1&gtexRnaSignalMaleYoung_hideKids=1&gtexRnaSignalMaleYoung=full&gtexRnaSignalSRR1311243=full&ignoreCookie=1
    + + + +
    Optional parameters that can be added to the URL:
    + + +

    Creating a URL with Multiple Track Hubs

    -If you are adding an assembly hub with multiple genomes, you can link directly to hgGateway, -the assembly selection page and a particular genome:

    +You can create a URL with multiple Track Hubs using the hubUrl= parameter. URL +parameters can be combined by using &. For example, using the following track hubs: +

    +
    +ENCODE DNA Trackhub
    +https://storage.googleapis.com/gcp.wenglab.org/hubs/dna20/hub.txt
    +
    +
    +JASPAR TFBS
    +http://expdata.cmmt.ubc.ca/JASPAR/UCSC_tracks/hub.txt
    +
    +
    +ReMap 2022 Regulatory Atlas
    +https://remap.univ-amu.fr/storage/public/hubReMap2022/hub.txt
    +
    +

    +The combination of the three hubs allows the creation of the following URL that can load the +three hubs on the Genome Browser. +

    +
    +https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hubUrl=https://storage.googleapis.com/gcp.wenglab.org/hubs/dna20/hub.txt&hubUrl=http://expdata.cmmt.ubc.ca/JASPAR/UCSC_tracks/hub.txt&hubUrl=https://remap.univ-amu.fr/storage/public/hubReMap2022/hub.txt
    + +

    Creating a URL for an Assembly Hub

    + +

    +The following example links to an assembly hub using the hubUrl= and +genome= parameters where in the example, genome=araTha1, is the assembly +name set for genome in the genomes.txt file. URL parameters can be combined by using &.

    +
    https://genome.ucsc.edu/cgi-bin/hgTracks?genome=araTha1&hubUrl=http://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubAssembly/plantAraTha1/hub.txt
    +

    +
    Additional hub connection parameters
    +
  • hubClear=connects the hub and disconnects other hubs that are in the same directory
  • +
  • hgHubConnectReplacing hgTracks with this parameter connects the hub and redirects the link to the +Track Data Hubs page
  • +
  • hgHubConnect.remakeTrackHub=on +acts to connect when pointed to /hgHubConnect
  • +
  • hgHub_do_firstDb=1 +uses the first database in genomes.txt
  • +
  • hgHub_do_redirect=on +redirects the attached hub to the Gateway page
  • + +
    Redirecting the URL to the Gateway page
    +

    +The following example link connects the hub and redirects the link to the Gateway page to display +the hub's description html page, which is defined in the genomes.txt by the htmlPath +setting, by using hgHubConnect, hgHub_do_redirect=on, +hgHubConnect.remakeTrackHub=on, hgHub_do_firstDb=1, and +hubUrl. + +

    http://genome.ucsc.edu/cgi-bin/hgHubConnect?hgHub_do_redirect=on&hgHubConnect.remakeTrackHub=on&hgHub_do_firstDb=1&hubUrl=http://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubAssembly/plantAraTha1/hub.txt
    +
    +

    +You can also link to the Gateway page to display the hub's description html page by using the +hgGateway and genome parameters. The following example links the hub to +the Gateway page:

    +
    http://genome.ucsc.edu/cgi-bin/hgGateway?genome=araTha1&hubUrl=http://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubAssembly/plantAraTha1/hub.txt 
    + +

    Creating a URL for an Assembly Hub with Multiple Track Hubs

    +

    +You can create a URL for an assembly hub with track hubs using a combination of the +hubUrl= and genome= URL parameters. URL parameters can be combined by +using &.For example, using the following assembly hub and track hubs: +

    +
    +Arabidopsis thaliana assembly hub
    +https://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubPlants/cshl2013/hub.txt
    +
    +
    +ReMap 2022 Regulatory Atlas
    +https://remap.univ-amu.fr/storage/public/hubReMap2022/hub.txt
    +
    +
    +UniBind 2021 Robust hub
    +https://unibind.uio.no/static/data/latest/UniBind_hubs_Robust/UCSC/hub.txt
    +
    +

    +The combination of the three hubs, along with genome=araTha1, allows for the creation of +the following URL that can load the three hubs on the Genome Browser. +

    +
    +https://genome.ucsc.edu/cgi-bin/hgTracks?genome=araTha1&hubUrl=https://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubPlants/cshl2013/hub.txt&hubUrl=https://remap.univ-amu.fr/storage/public/hubReMap2022/hub.txt&hubUrl=https://unibind.uio.no/static/data/latest/UniBind_hubs_Robust/UCSC/hub.txt
    + + + +

    Creating a URL for a GenArk assembly with a track hub

    +

    +When creating a track hub for a GenArk assembly, there is no need to do any attaching of the +assembly hub itself via the hubUrl= URL parameter. GenArk hubs will automatically +attach themselves if the track hub mentions the GCA_ or GCF_ name identifier of the assembly hub. +Simply load the track hub on the Genome Browser, and the assembly hub will automatically appear. For +example, the following example track hub will load an additional track for the pig (GCA_002844635.1) +GenArk assembly. +

    +

    +To create a link to the track hub that references a GenArk assembly, the +genome=GCA_002844635.1 and hubUrl= URL parameters can be used like in the +following example: +

    +
    +https://genome.ucsc.edu/cgi-bin/hgTracks?genome=GCA_002844635.1&hubUrl=https://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubGenArkExample/genArkTrackHub/hub.txt
    +
    +

    Setting up your own Track Hub

    This section provides a step-by-step description of the process used to set up a track hub on your own server. If you would like information about how to attach a track hub to an existing assembly hub, please refer to the following FAQ entry.

    To create your own hub you will need: