220420c493c9dd3d509cd6fb6084b3bf756d8ef4 dschmelt Fri May 24 12:09:02 2019 -0700 Making b0b's CR changes #23528 diff --git src/hg/htdocs/FAQ/FAQlink.html src/hg/htdocs/FAQ/FAQlink.html index 52f72b4..ec19c73 100755 --- src/hg/htdocs/FAQ/FAQlink.html +++ src/hg/htdocs/FAQ/FAQlink.html @@ -16,131 +16,129 @@ <li><a href="#custUrl">Loading Custom Tracks with the URL</a></li> <li><a href="#hubUrl">Loading Track Hubs and Assembly Hubs with the URL</a></li> <li><a href="#link3">Linking to gene specific information</a></li> <li><a href="#hgsid">The hgsid parameter</a></li> <li><a href="#moreInfo">Additional URL parameters</a></li> </ul> <a name="link1"></a> <h2>Creating a sharable URL to view specific tracks</h2> <h6>How do I create a link to the Genome Browser to share my data?</h6> <p> The easiest way to save and share tracks from the URL is by <a href="../cgi-bin/hgLogin" TARGET="_blank">logging in</a> to your Genome Browser account and creating a <a href="../goldenPath/help/hgSessionHelp.html">saved session</a>. Saved sessions are a versatile way to share data that may include native annotations, Custom -Tracks, Track Hubs, and Assembly Hubs. Note that the <input> format indicates a -user choice and not a valid example.</p> +Tracks, Track Hubs, and Assembly Hubs. In these examples, text in brackets "<" and ">" +indicate places where the user supplies information.</p> <p> You will be able to share Genome Browser sessions with the following link format:</p> <p><code>http://genome.ucsc.edu/s/<userName>/<sessionName></code></p> <p> For instructions on creating a saved session, go to the <a href="../goldenPath/help/hgSessionHelp.html#Create" target ="_blank">session user guide</a>. If you want to specify track settings in a URL directly, please read the section on <a href="#trackViz">setting track visibility via URL</a> for a complete description. </p> <p> Or if you prefer the older style, which allows you to link to different tools, you may use the following format:</p> -<p><code>http://genome.ucsc.edu/cgi-bin/hgTracks?hgS_doOtherUser=submit&hgS_otherUserName=<userName>&gS_otherUserSessionName=<SessionName></code></p> +<p><code>http://genome.ucsc.edu/cgi-bin/hgTracks?hgS_doOtherUser=submit&hgS_otherUserName=<userName>&gS_otherUserSessionName=<sessionName></code></p> <p> This longer format has the flexibility of replacing "hgTracks" with different tool names to share saved settings on the Table Browser (hgTables), Variant Annotation Integrator (hgVai), or Data Integrator (hgIntegrator). This will preserve your option selections and can be useful to share. The following format will bring the recipient to a user's custom Table Browser selections:</p> -<p><code>http://genome.ucsc.edu/cgi-bin/hgTables?hgS_doOtherUser=submit&hgS_otherUserName=<userName>&hgS_otherUserSessionName=<SessionName></code></p> +<p><code>http://genome.ucsc.edu/cgi-bin/hgTables?hgS_doOtherUser=submit&hgS_otherUserName=<userName>&hgS_otherUserSessionName=<sessionName></code></p> <p>Both session link formats have the advantage of being able to add URL parameters to the end. The shorter link format requires a question mark before any URL parameters, with ampersand characters separating different parameters like so: </p> <p><code><a href=http://genome.ucsc.edu/s/view/clinicalzoom?textSize=18>http://genome.ucsc.edu/s/view/clinicalzoom?textSize=18</a></code></p> <p>The longer format requires an ampersand between each parameter, like so:</p> <p><code><a href=http://genome.ucsc.edu/cgi-bin/hgTracks?hgS_doOtherUser=submit&hgS_otherUserName=view&hgS_otherUserSessionName=clinicalzoom&textSize=18>http://genome.ucsc.edu/cgi-bin/hgTracks?hgS_doOtherUser=submit&hgS_otherUserName=view&hgS_otherUserSessionName=clinicalzoom&textSize=18</a></code></p> <a name="link2"></a> <h2>Linking to the Browser at a specific position</h2> <h6>How do I make a link to a specific genome or position?</h6> <p> You can link to a specific genome assembly and position in the Genome Browser using a URL with -the <code>db=</code> and <code>position=</code> parameters. Note that the <input> -format indicates a user choice and not a valid example.</p> +the <code>db=</code> and <code>position=</code> parameters.</p> <p><code>http://genome.ucsc.edu/cgi-bin/hgTracks?db=<assembly>&position=<position></code></p> <p> Where:</p> <ul> <li> <code>db</code> - designates a specific genome assembly. For example, <code>db=hg19</code> refers to the Feb. 2009 human genome release. For a list of db parameter values that correspond to UCSC assemblies, see the <a href="FAQreleases.html#release1">list of UCSC releases</a>.</li> <li><code>position</code> - can be any search term for the genome specified, including a position range or a gene identifier. This often takes the form of <code>position=chr1:35000-40000</code>.</li> </ul> <p>The following link is an example of a URL that declares assembly and position:</p> <p><code><a href="../cgi-bin/hgTracks?db=hg19&position=chr1:35000-40000">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg19&position=chr1:35000-40000</a></code></p> <a name="trackViz"></a> <h2>Setting Track Visibility via URL</h2> <h6>How do I create a custom URL to control the visibility of specific tracks?</h6> <p> You can control the visibility of tracks from the URL with the following parameters, each linked by the "&" sign, similar to position parameters. For more information, please see the <a href="../goldenPath/help/customTrack.html#optParams" target ="_blank">optional URL -parameters</a> section of the Custom Tracks User's Guide. Note that the <input> format indicates -a user choice and not a valid example.</p> +parameters</a> section of the Custom Tracks User's Guide.</p> <ul> <li><code>hideTracks=1</code> - hides all tracks</li> <li><code><trackName>=hide|dense|pack|full</code> - sets specified track or subtrack to a chosen visibility</li> <li><code>textSize=<number></code> - sets browser text size to either 6,8,10,12,14,18,24,or 34. Default is a textSize of 8.</li> <li><code>ignoreCookie=1</code> - removes pre-existing user settings like track seletion, custom tracks, and track hubs</li> </ul> <p> For example, you can use the following command to hide every track (hideTracks=1) and set the knownGene track to the pack visibility (knownGene=pack):</p> <p><code><a href="../cgi-bin/hgTracks?db=hg38&hideTracks=1&knownGene=pack">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hideTracks=1&knownGene=pack</a></code></p> <p>Composite tracks have additional URL parameters that encode options to hide, select, and display subtracks.</p> <ul> <li><code><trackName>_hideKids=1</code> - hides a specific composite track's subtracks</li> <li><code><trackName>_sel=1</code> - selects specific subtrack to be 'checked', allowing display</li> </ul> <p>For example, the following URL hides all tracks (hideTracks=1), hides a specific composite track's default subtracks (refSeqComposite_hideKids=1), turns on one specific subtrack (ncbiRefSeqCurated=full), and checks a box to display that subtrack (ncbiRefSeqCurated_sel=1). -<pre><a href="../cgi-bin/hgTracks?db=hg38&hideTracks=1&refSeqComposite_hideKids=1&ncbiRefSeqCurated=full&ncbiRefSeqCurated_sel=1">https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hideTracks=1&refSeqComposite_hideKids=1&ncbiRefSeqCurated=full&ncbiRefSeqCurated_sel=1</a></pre> +<pre><a href="../cgi-bin/hgTracks?db=hg38&hideTracks=1&refSeqComposite_hideKids=1&ncbiRefSeqCurated=full&ncbiRefSeqCurated_sel=1" target="_blank">https://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hideTracks=1&refSeqComposite_hideKids=1&ncbiRefSeqCurated=full&ncbiRefSeqCurated_sel=1</a></pre> <h2>Loading data with the URL</h2> <a name="custUrl"></a> <h3>Loading Custom Track data with the URL</h3> <h6>How do I create a link to my custom track data?</h6> <p> You can combine the URL visibility settings with the <code>hgct_customText=</code> parameter using a track line you would otherwise put in the <a href="../cgi-bin/hgCustom">custom track input box</a>. The following example shows the <code>hgct_customText</code> parameter accepting a bigBed file URL as a custom track: </p> -<pre><a href="../cgi-bin/hgTracks?db=hg38&position=chr21:34821279-34888690&hgct_customText=https://genome.ucsc.edu/goldenPath/help/examples/bigBedExample.bb">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&position=chr21:34821279-34888690&hgct_customText=https://genome.ucsc.edu/goldenPath/help/examples/bigBedExample.bb</a></pre> +<pre><a href="../cgi-bin/hgTracks?db=hg38&position=chr21:34821279-34888690&hgct_customText=https://genome.ucsc.edu/goldenPath/help/examples/bigBedExample.bb" target="_blank">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&position=chr21:34821279-34888690&hgct_customText=https://genome.ucsc.edu/goldenPath/help/examples/bigBedExample.bb</a></pre> <p> If you want to add more information to the Custom Track, you can do so using the <code>hgct_customText</code> parameter. Since this is a URL, you must use "%20" to encode for spaces and "%0A" for a new line character. For example, the following example shows Custom Track input pasted in the <a href="../cgi-bin/hgCustom">custom track input box</a> and the equivalent input in the URL: <pre>browser position chr21:33038946-33039092 track type=bam bigDataUrl=https://genome.ucsc.edu/goldenPath/help/examples/bamExample.bam name=Example description=ExampleBAM</pre> <pre><a href="../cgi-bin/hgTracks?db=hg38&hgct_customText=browser%20position%20chr21:33038946-33039092%0Atrack%20type=bam%20bigDataUrl=https://genome.ucsc.edu/goldenPath/help/examples/bamExample.bam%20name=Example%20description=ExampleBAM">http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&hgct_customText=browser%20position%20chr21:33038946-33039092%0Atrack%20type=bam%20bigDataUrl=https://genome.ucsc.edu/goldenPath/help/examples/bamExample.bam%20name=Example%20description=ExampleBAM</a></pre> <p> More information on custom track parameters can be found in the <a href="../goldenPath/help/customTrack.html">Custom Track user guide</a>.</p>