caec93e67f0067fd2363cf1faf4fa323b30d3716 max Thu Nov 2 04:40:18 2023 -0700 adapting more pages to china, refs #32535 diff --git src/hg/htdocs/goldenPath/help/multiRegionHelp.html src/hg/htdocs/goldenPath/help/multiRegionHelp.html index 9e7f5c5..6e45d88 100755 --- src/hg/htdocs/goldenPath/help/multiRegionHelp.html +++ src/hg/htdocs/goldenPath/help/multiRegionHelp.html @@ -1,422 +1,438 @@ <!DOCTYPE html> <!--#set var="TITLE" value="Genome Browser Multi-Region" --> <!--#set var="ROOT" value="../.." --> <!-- Relative paths to support mirror sites with non-standard GB docs install --> <!--#include virtual="$ROOT/inc/gbPageStart.html" --> <h1>Multi-Region Display Help</h1> <h2>Contents</h2> <div class="row"> <div class="col-md-4"> <h6><a href="#Intro">Introduction</strong></a></h6> <h6><a href="#GetStarted">Getting started with Multi-Region View</a></h6> <h6><a href="#About">About the Multi-Region modes</a></h6> <ul> <li><a href="#ExonOnly"><strong>Exon only</strong></a></li> <li><a href="#GeneOnly"><strong>Gene only</strong></a></li> <li><a href="#CustomRegions"><strong>Custom regions</strong></a></li> <li><a href="#Haplotype"><strong>Haplotype view</strong></a></li> </ul> <h6><a href="#Videos">Video demonstrations of Multi-Region modes</a></h6> <ul> <li><a href="#ExonOnlyVid"><strong>Exon only</strong></a></li> <li><a href="#CustomRegionsVid"><strong>Custom regions</strong></a></li> <li><a href="#HaplotypeVid"><strong>Haplotype view</strong></a></li> </ul> <h6><a href="#Examples">Examples</a></h6> </div> <div class="col-md-8"> <form name="googleForm1" method="GET" action="https://www.google.com/search" onSubmit="document.googleForm1.q.value=document.googleForm1.qq.value+ ' site:genome.ucsc.edu/goldenPath/help';"> <p> Search the Genome Browser help pages: <input type="hidden" name="q" value=""> <input type="hidden" name="num" value="10"> <input type="hidden" name="filter" value="0"> <input type=text name=qq size=30 maxlength=255 value=""> <input type="submit" value="Submit"> </form> </p> <p><a href="../../contacts.html">Questions and feedback are welcome</a>. </div> </div> <a name="Intro"></a> <h2>Introduction</h2> <p> The multi-region display allows users to "slice" their track-viewing experience into a variety of different modes that focus the display on certain features: exon-only, gene-only, or user-defined BED coordinates. Only the portions of track annotations that fall within these displayed regions are shown; extraneous intergenic, intronic and otherwise unwanted regions are hidden from view.</p> <p> For human assemblies hg17 and later, the multi-region view also supports the replacement of a section of the reference genome with an alternate haplotype chromosome. This allows the user to view annotations upstream and downstream of the haplotype sequence, and visualize the haplotype in the general context of the reference chromosome.</p> <p> Using the multi-region display, one can: <ul> <li> Show all SNPs that fall within exons (exon-only view).</li> <li> Show only the genes on a chromosome (gene-only view).</li> <li> Display the same chromosomal position on either side of a gene in order to model a repeat region (using custom regions in BED format).</li> <li> See how an alternate haplotype fits onto its chromosome (alternate haplotype view).</li> </ul> <a name="GetStarted"></a> <h2>Getting started With Multi-Region view</h2> <p> Follow these steps to activate and configure multi-region view in the Genome Browser.</p> <p> <strong>Step 1. Pick a genome assembly and region</strong><br> Open the Genome Browser tracks display to a region of interest within a standard genome assembly, or open a custom region within an assembly hub.</p> <p> <strong>Step 2. Open the multi-region view configuration window</strong><br> Click <button type="button">multi-region</button> under the tracks display to open the multi-region configuration window.</p> <p> <img src="../../images/multiRegionButton.png" alt="Multi-Region button" width="799" height="201"></p> <p> <strong>Step 3. Configure the multi-region view</strong><br> By default, the <strong>Exit multi-region mode</strong> button is selected. This button returns the display to the traditional view.</p> <p> <img src="../../images/multiRegionConfig.png" alt="Configure Multi-Region view" width="701" height="387"> </p> <p> To activate a multi-region view, click one of these options:</p> <ul> <li> <strong>Show exons using</strong> -- display only the exonic regions (keyboard shortcut: "e v")</li> <li> <strong>Show genes using</strong> -- display only those regions with gene annotations in the specified genes track</li> <li> <strong>Enter custom regions as BED, or a URL to them</strong> -- display only those regions entered into the text box in BED format, or listed in a specified BED file</li> <li> <strong>Show one alternate haplotype</strong> -- display the specified alternate haplotype in place on the reference chromosome (human assemblies hg17 and later only)</li> <li> (Optional) Select <strong>Highlight alternating regions in multi-region view</strong> to color alternating slices in blue.</li> </ul> <p> Click <button type="button">submit</button> to save your changes and return to the Genome Browser tracks display.</p> <p> Here is a view of the Genome Browser with the "Show exons" and "Highlight alternating regions" options selected:</p> <p> <img src="../../images/multiRegionExample.png" alt="Exon-only screenshot" width="950" height="380"></p> <p> <strong>Navigation and display</strong><br> With a few exceptions, most browser navigation and display features function the same in both multi-region and single-chromosome modes, including zooming in and out, reversing and resizing the view, highlighting and zooming to a selected region, and track search. Searching and zooming conventions differ when displaying custom BED regions. See <a href="#CustomRegions">About Custom Regions</a> for more information.</p> <a name="About"></a> <h2>About the Multi-Region modes</h2> <a name="ExonOnly"></a> <h3>Exon-only mode</h3> <p> The exon-only view shows only those bases and annotations that fall within an exon or padding region. Bases and alignments within intronic and intergenic regions are removed from the display.</p> <p> The exon-only view "virtual chromosome" is constructed of all the exons present in the gene track specified in the multi-region configuration window. Exon "slices" are visually separated by blocks of intronic or intergenic bases, the size of which are set by the padding field. This designates the padding on both sides of an exon, and therefore is additive, e.g., a padding size of 6 will result in a 12-base space between exon slices:</p> <p> <img src="../../images/MultiRegionExonPadding.png" alt="Multi-Region padding" width="950" height="171"> </p> <p> If the gene track used to compute the slicing is a <a href="./trackDb/trackDbDoc.html#superTrack">super track</a> or contains other transcripts, only the longest exon will be used to determine slicing, regardless of whether or not they are in the same transcript. See <a href="#Example1">Example 1</a> for more information. <p> <a href ="#ExonOnlyVid">Video</a> </p> <a name="GeneOnly"></a> <h3>Gene-only mode</h3> <p> The gene-only view displays the bases and annotations that fall within the coordinates of a gene, but hides all of the intergenic bases except those used for padding (<a href="#Example2">Example 2</a>). As with exon-only mode, the padding field sets the number of intergenic bases displayed to visually separate each gene slice.</p> <p> Because genes and alternate transcripts often overlap by a few bases, the windows created by the gene-only (and exon-only) mode may sometimes merge together. Reducing the number of padding bases may increase the number of alternate regions by allowing less intergenic space between genes. However, this overlap is a common feature for most of the Genome Browser gene sets, and should be no cause for concern.</p> <a name="CustomRegions"></a> <h3>Custom regions mode</h3> <p> The custom regions mode allows user-specific modeling of genomic regions by either entering them into the text box, or linking to a <a href="../../FAQ/FAQformat.html#format1">BED</a> file. Typically when a BED file is loaded into the browser, the entries are displayed in the tracks window in order of chromosomal location, regardless of the order in the file. When the multi-region view option is selected, the BED file entries are displayed in the same order they appear in the file. This feature can be used to manipulate the display of other annotations in the browser window, for example to duplicate a display region, reorder the exon display within a gene, or display regions from 2 different chromosomes side-by-side. <a href="#Example3">Example 3</a> demonstrates the importance of ordering entries within a file.</p> <p> Although all types of BED files are supported, only the information from BED 3 or BED 12 files is relevant to the display. Like BED custom tracks, comments are supported in the BED files used by multi-region mode. Comments are included at the top of the BED file, preceded by "#". The supported comments are:</p> <ul> <li> <strong>#database:</strong> The genome assembly database for which the BED file is intended. If the file is loaded onto a different assembly, the custom regions mode will not work.</li> <li> <strong>#shortDesc:</strong> (Optional) A short description of the custom region, displayed next to the chromosome ideogram.</li> <li> <strong>#padding:</strong> Sets the size of the padding on either side of a multi-region boundary in the browser tracks window.</li> </ul> <p> Here is an example of a BED3 file with comments:</p> <pre><code>#database hg38 #shortDesc Example of a short description #padding 6 chr1 pos1 pos2 chr2 pos1 pos2 </code></pre> <p> The Genome Browser search mechanism functions differently when using custom BED regions in multi-region view. When searching for a term or position, the browser first searches for the term within the BED-defined regions. If the item is found, the browser display will shift to that location.</p> <p> If the term is not found within the BED-defined regions, but is found elsewhere, the browser will display a message asking if you would like to return to a default view at that location. If you prefer to return to your custom region instead, click <button type="button">OK</button>. Otherwise, click "here" to return to the default view. </p> <p> <img src="../../images/MultiRegionBEDSearchRedirectMessage.png" alt="Multi-Region search redirect" width="691" height="97"></p> <p> If the term is not found at all in the assembly, an error message will display.</p> <p> When scrolling or zooming while viewing regions from a custom BED URL, the range is restricted to the BED-defined regions. Although you can still zoom in to single base resolution, the outward zoom is limited to the extent of the defined regions. Scrolling upstream and downstream is also limited to the BED-defined range.</p> <p> <a href ="#CustomRegionsVid">Video</a> </p> <a name="Haplotype"></a> <h3>Haplotype mode</h3> <p> An additional viewing mode is available on human assemblies hg17 and later: showing an alternative haplotype placed in its chromosomal context (<a href="#Example5">Example 5</a>). The haplotype is specified by entering its ID in the form <em>chr_name_alt</em> in the configuration window. To view the list of haplotype IDs for a given assembly, go to <code>http://hgdownload.soe.ucsc.edu/goldenPath/<strong>$db</strong>/bigZips/<strong>$db</strong> .chrom.sizes</code>, where <strong><code>$db</code></strong> is the human assembly name (e.g., hg38, hg19, hg18 or hg17).</p> <p> Alternatively, haplotypes can be viewed using the <strong>Alt Map...</strong> track in the Mapping and Sequencing group. Open the track and navigate to the haplotype of interest in the track window. Click on the haplotype to display its details page, then click the link <strong>Show this alternate haplotype placed on its chromosome</strong>.</p> <p> <a href ="#HaplotypeVid">Video</a> </p> <a name="Videos"></a> <p> </p> <h2>Videos</h2> <a name="ExonOnlyVid"></a> <p> </p> <h3>Video demonstration of Exon-only mode</h3> <p> </p><p> +<!--#if expr="${SERVER_NAME} = /-china/" --> + <a href='../../../videos/mNEJBOkf_Gk.mp4'> + <img src=../../images/videoIcon.png></a> + + Visit our <a href="/videos/" target="_blank">Video Page</a>. +<!--#else --> <iframe width="560" height="315" src="https://www.youtube.com/embed/mNEJBOkf_Gk?rel=0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> - Visit our <a href="https://www.youtube.com/channel/UCQnUJepyNOw0p8s2otX4RYQ/videos" target="_blank">YouTube channel</a>. +<!--#endif --> </p> <a name="CustomRegionsVid"></a> <p> </p> <h3>Video demonstration of Custom Regions </h3> <p> </p><p> +<!--#if expr="${SERVER_NAME} = /-china/" --> + <a href='../../../videos/ht4sGj1Tlxw.mp4'> + <img src=../../images/videoIcon.png></a> + + Visit our <a href="/videos/" target="_blank">Video Page</a>. +<!--#else --> <iframe width="560" height="315" src="https://www.youtube.com/embed/ht4sGj1Tlxw?rel=0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> - Visit our <a href="https://www.youtube.com/channel/UCQnUJepyNOw0p8s2otX4RYQ/videos" target="_blank">YouTube channel</a>. +<!--#endif --> </p> - <a name="HaplotypeVid"></a> <p> </p> <h3>Video demonstration of Haplotype Substitution using Multi-Region</h3> <p> +<!--#if expr="${SERVER_NAME} = /-china/" --> + <a href='../../../videos/0lKYdqQus0I.mp4'> + <img src=../../images/videoIcon.png></a> + + Visit our <a href="/videos/" target="_blank">Video Page</a>. +<!--#else --> <iframe width="560" height="315" src="https://www.youtube.com/embed/0lKYdqQus0I?rel=0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> - Visit our <a href="https://www.youtube.com/channel/UCQnUJepyNOw0p8s2otX4RYQ/videos" target="_blank">YouTube channel</a>. -<p> -</p><p> +<!--#endif --> +</p> <a name="Examples"></a> <h2>Examples</h2> <a name="Example1"></a> <h3>Example 1. Exon-only mode</h3> <p> This screenshot shows the exon-only view for the SOD1 gene in human assembly hg38. The third "exon" from the left falls within the intron of the actual SOD1 gene, but is shown as an exon because it is part of the GENCODE v22 super-track.</p> <p> <img src="../../images/MultiRegionSOD1.png" alt="Screenshot of exon-only mode" width="950" height="257"></p> <p> Click <a href="../../cgi-bin/hgTracks?hgS_doLoadUrl=submit&hgS_loadUrlName=http://genome.ucsc.edu/ goldenPath/help/examples/sessions/exonOnlySession.txt">here</a> to view this example in the Genome Browser. To quickly exit multi-region mode and return to the default single chromosome view, use the keyboard shortcut "d v".</p> <a name="Example2"></a> <h3>Example 2. Gene-only mode</h3> <p> This example illustrates how intergenic regions are removed from the default browser tracks view in gene-only mode. The displayed region of the X chromosome on the human hg19 assembly consists of three genes (DKC1, MPP1, and F8) with varying amounts of intergenic space separating them. The first screenshot shows the standard browser display of the gene track in "single chromosome" view. Compare it with the second screenshot, which shows the same region in gene-only mode with the padding set to 6. (Click <a href="../../cgi-bin/hgTracks?hgS_doLoadUrl=submit&hgS_loadUrlName=http://genome.ucsc.edu/ goldenPath/help/examples/sessions/geneOnlySession.txt">here</a> to view this example in the Genome Browser.)</p> <p> <img src="../../images/MultiRegionXDefault.png" alt="Genome Browser default gene track" width="950" height="238"></p> <p> <img src="../../images/MultiRegionXGeneOnly.png" alt="Multi-Region gene-only view" width="950" height="247"> </p> <p> To quickly exit multi-region mode and return to the default single chromosome view, use the keyboard shortcut "d v".</p> <a name="Example3"></a> <h3>Example 3. Custom regions from BED file</h3> <p> Here is an example <a href="../help/examples/mm10multiRegionexample.txt">BED file</a> for mm10 that contains a list of exon positions for the Pax9 gene. If this file is loaded into the browser as a custom track <em>without</em> turning on multi-region mode, the blocks display in order of genomic position, not in the order they are specified in the file:</p> <p> <img src="../../images/MultiRegionBEDFileInOrder.png" alt="Genome Browser default gene display" width="950" height="94"></p> <p> However, if multi-region mode is turned on after loading a custom track, the blocks display in the order they are listed in the BED file, rather than in genomic position order. This in turn affects the display order of other features in this view, in this case the display order of the exons in Pax9. This feature can be used to manipulate the display of other annotations, for example to allow the visualization of centromeric regions or viewing the same gene twice within the same window to compare annotations in a separate region.</p> <p> <img src="../../images/MultiRegionBEDFileOutOrder.png" alt="Multi-Region bed custom output" width="950" height="94"></p> <p> Click <a href="../../cgi-bin/hgTracks?hgS_doLoadUrl=submit&hgS_loadUrlName=http://genome.ucsc.edu/ goldenPath/help/examples/sessions/bed3Session.txt">here</a> to view this example in the Genome Browser. To quickly exit multi-region mode and return to the default single chromosome view, use the keyboard shortcut "d v". <a name="Example4"></a> <h3>Example 4. BED12</h3> <p> The following <a href="../help/examples/bed12formultregion.txt">BED file</a> utilizes BED12 format to display two regions from two different chromosomes, chromosome 22 and chromosome 21, side-by-side in the browser tracks window, along with human genes POTEH, CECR2, USP25 and CHODL.</p> <pre><code>chr22 15690026 17558149 chr22 960 + 15690026 17558149 0 2 31497,81057, 0,1787066 chr21 15730025 18267373 chr21 960 + 15730025 18267373 0 2 148887,22540, 0,2514808</code></pre> <p> <img src="../../images/MultiRegionBED12Example.png" alt="Multi-Region BED12 example" width="881" height="344"></p> <p> The multi-region display utilizes the data in the blockStarts and blockSizes fields of the BED file to draw its regions, allowing for even more customization of the Genome Browser display.</p> <p> Click <a href="../../cgi-bin/hgTracks?hgS_doLoadUrl=submit&hgS_loadUrlName=http://genome.ucsc.edu/ goldenPath/help/examples/sessions/bed12Session.txt">here</a> to view this example in the Genome Browser. To quickly exit multi-region mode and return to the default single chromosome view, use the keyboard shortcut "d v".</p> <a name="Example5"></a> <h3>Example 5. Haplotype</h3> <p> This example shows how the human hg38 haplotype chr1_KI270762v1_alt fits onto chromosome 1. Note that annotations from the standard browser display do not extend into or out of the haplotype region, since haplotypes are annotated separately from regular chromosomes.</p> <p> <img src="../../images/MultiRegionHaplotypeView.png" alt="Multi-Region haplotype view" width="881" height="359"></p> <p> Click <a href="../../cgi-bin/hgTracks?hgS_doLoadUrl=submit&hgS_loadUrlName=http://genome.ucsc.edu/ goldenPath/help/examples/sessions/haplotypeSession.txt">here</a> to view this example in the Genome Browser. To quickly exit multi-region mode and return to the default single chromosome view, use the keyboard shortcut "d v".</p> <!--#include virtual="$ROOT/inc/gbPageEnd.html" -->