9a051963c7dc7cafea316417701cae4570aff029 braney Sun Jul 13 13:07:07 2025 -0700 templates for bedMethyl and bigMethyl diff --git src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml index 7b53228faa2..a628e721b3e 100644 --- src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml +++ src/hg/htdocs/goldenPath/help/trackDb/trackDbLibrary.shtml @@ -389,31 +389,31 @@ <DIV class="yAxisNumLabels"><span class="types bigLolly"></span> <div class="format"><code>yAxisNumLabels.<on/off> <integer></code></div> Turn the y axis number labels on or off </DIV> <DIV class="bigDataUrl"><span class="types bigBarChart bigBed bigChain bigInteract bigLolly bigMaf bigPsl bigWig bam hic vcfTabix vcfPhasedTrio"></span> <div class="format"><code>bigDataUrl <url/relativePath></code></div> <P class="isRequired">Required: <span class="red">For Hubs</span></P> <P>The location of a remote data file containing the bulk of the data for the track. This setting is required for all data tracks in a track hub. </P> <!-- THIS SHOULD BE FIXED for local tracks! --> <P>The setting is either the full URL (including <code>http:</code> or another protocol) or it is relative to the directory in which the trackDb file containing this setting is located. The file must be in one of the supported remote data file formats: bam/cram, bigBarChart, bigBed, bigChain, bigLolly, - bigInteract, bigMaf, bigPsl, bigGenePred, bigNarrowPeak, bigWig, vcfTabix, or hic. + bigInteract, bigMaf, bigPsl, bigGenePred, bigMethyl, bigNarrowPeak, bigWig, vcfTabix, or hic. Note that bam/cram and vcfTabix/vcfPhasedTrio types require a separate index file that must have the same name as the data file plus a standard suffix (".bai" and ".tbi" respectively), unless <A <A onclick="jumpTo(this)" HREF="#">bigDataIndex</A> is used. All occurrences of the string <code>$D</code> in the URL will be substituted with the genome assembly database name. This allows a trackDb entry to be used with for multiple assemblies. <code>$D</code> substitution is not implemented for track hubs. </P> <P><B>Example:</B></P> <pre> bigDataUrl http://vizhub.wustl.edu/VizHub/hg19/biBrainH3K4me1.bb</pre> or <pre> bigDataUrl biBrainH3K4me1.bb</pre> </DIV> @@ -932,92 +932,92 @@ entry "11932250,34718705" would create two links.</p> <p> If an entry of comma-separated values contains a "|" symbol, the part before the pipe symbol is used to replace the $$ wildcard and the part after it is used as the label, as opposed to the default label description in the .as file. This pipe substitution is similar to how Wikipedia markup encodes links. In the example below, a value for the field pmid of "11932250|W James Kent" would create a link with the URL https://www.ncbi.nlm.nih.gov/pubmed/11932250 and the label "W James Kent".</p> <P><B>Example:</B></P> <pre> urls pmid="https://www.ncbi.nlm.nih.gov/pubmed/$$" spId="http://www.uniprot.org/uniprot/$$" </pre> </DIV> -<DIV class="skipEmptyFields"><span class="types bigBed bigPsl bigGenePred bigNarrowPeak bigMaf bigChain"></span> +<DIV class="skipEmptyFields"><span class="types bigBed bigPsl bigGenePred bigMethyl bigNarrowPeak bigMaf bigChain"></span> <div class="format"> <code>skipEmptyFields on</code><BR> </div> <P>If this setting is "on", the item details page will not show fields that have empty values. This can be useful when you have numerous extra fields but only few of them have a value.</P> </DIV> -<DIV class="skipFields"><span class="types bigBed bigPsl bigGenePred bigNarrowPeak bigMaf bigChain"></span> +<DIV class="skipFields"><span class="types bigBed bigPsl bigGenePred bigMethyl bigNarrowPeak bigMaf bigChain"></span> <div class="format"> <code>skipFields <fieldName1>="<url1>" <fieldName2>="<url2>" ...</code><BR> </div> <P>This setting can be used to suppress extra fields on the item details page. It can be useful if you do not want to show fields that are only used for mouseOvers or labels. </P> <P><B>Example:</B></P> <pre> skipFields mouseOver,labelField,hiddenField </pre> </DIV> -<DIV class="sepFields"><span class="types bigBed bigPsl bigGenePred bigNarrowPeak bigMaf bigChain"></span> +<DIV class="sepFields"><span class="types bigBed bigPsl bigGenePred bigMethyl bigNarrowPeak bigMaf bigChain"></span> <div class="format"> <code>sepFields fieldName1,fieldName2 ...</code><BR> </div> <P>This setting changes the item details page and splits the table used for showing extra fields before any of the specified fields. It can be useful to visually separate extra fields into logical categories. </P> <P><B>Example:</B></P> <pre> sepFields pmid,spId </pre> </DIV> -<DIV class="mouseOverField"><span class="types bigBed bigPsl bigChain bigMaf bigNarrowPeak bigGenePred"></span> +<DIV class="mouseOverField"><span class="types bigBed bigPsl bigChain bigMaf bigMethyl bigNarrowPeak bigGenePred"></span> <div class="format"> <code>mouseOverField <fieldName1></code><BR> </div> <P>For bigBed files with more than 8 fields (not counting any extra bigBed fields), this adds mouse over text that are different from the "name" field of a bigBed file. If the field is empty then the mouse over will fallback to the name field. </P> <P> To make this work, create a bigBed file with at least 8 columns and put the text for the mouse over into an extra bigBed field as explained in example 3 of the <a href="/goldenPath/help/bigBed.html">bigBed documentation</a>. The field name from your .as file is the field name for this statement. </P> <P><B>Example:</B></P> <pre> mouseOverField comment </pre> </DIV> -<DIV class="mouseOver"><span class="types bigBed bigPsl bigChain bigMaf bigNarrowPeak bigGenePred"></span> +<DIV class="mouseOver"><span class="types bigBed bigPsl bigChain bigMaf bigMethyl bigNarrowPeak bigGenePred"></span> <div class="format"> <code>mouseOver <pattern></code><BR> </div> <P>For bigBed files with more than 8 fields (not counting any extra bigBed fields), this adds mouse over text from a pattern based on the values of fields in the file. The pattern is constructed with fieldnames from the .as file, preceded by the dollar sign ($) and optional curly braces ({}), and can include arbitrary text between the field names. When field names may be prefixes or overlap with one another, as in the below example, curly braces can be used to more clearly define the field name to be used.</P> <P><B>Example:</B></P> <pre> mouseOver variant $name/$chrom:${chromStart} value $score </pre> @@ -1091,30 +1091,40 @@ The bigPsl format stores alignments between two sequences, as PSL files do, but they are compressed and indexed as bigBeds. bigPsl files are created using the program bedToBigBed with a special AutoSQL file that defines the fields of the bigPsl. The resulting bigPsl files are in an indexed binary format. The main advantage of the bigPsl files is that only portions of the files needed to display a particular region are transferred to UCSC. So for large data sets, bigPsl is considerably faster than regular PSL files. The bigPsl file remains on your web accessible server (http, https, or ftp), not on the UCSC server. Only the portion that is needed for the chromosomal position you are currently viewing is locally cached as a "sparse file". For complete bigPsl format definitions please see the <A HREF="../bigPsl.html">bigPsl help page</A>.</P> </DIV> <DIV class="bigGenePred_intro"> <H3>bigGenePred: Gene Annotations</H3> <P> The bigGenePred format stores annotation items that are a linked collection of exons, much as BED files indexed as bigBeds do, but bigGenePred has additional information about the coding frames and other gene specific information in eight additional fields. bigGenePred files are created using the program bedToBigBed with a special AutoSQL file that defines the fields of the bigGenePred. The resulting bigBed files are in an indexed binary format. The main advantage of the bigBed files is that only portions of the files needed to display a particular region are transferred to UCSC. So for large data sets, bigBed is considerably faster than regular BED files. The bigBed file remains on your web accessible server (http, https, or ftp), not on the UCSC server. Only the portion that is needed for the chromosomal position you are currently viewing is locally cached as a "sparse file". For complete bigGenePred format definitions please see the <A HREF="../bigGenePred.html">bigGenePred help page</A>.</P> </DIV> +<DIV class="bigMethyl_intro"> +<H3>bigMethyl: Metholated sites</H3> + <P> + The bigMethyl format stores methylation sights. bigMethyl files are based on the bigBed format. The first nine fields are the same as bed. The other nine include various scores. + + bigMethyl files are created using the program bedToBigBed with a special AutoSQL file that defines the fields of the bigMethyl. The resulting bigBed files are in an indexed binary format. The main advantage of the bigBed files is that only portions of the files needed to display a particular region are transferred to UCSC. So for large data sets, bigBed is considerably faster than regular BED files. The bigBed file remains on your web accessible server (http, https, or ftp), not on the UCSC server. Only the portion that is needed for the chromosomal position you are currently viewing is locally cached as a "sparse file". + For complete bigMethyl format definitions please see the + <A HREF="../bigMethyl.html">bigMethyl help page</A>.</P> +</DIV> + <DIV class="bigNarrowPeak_intro"> <H3>bigNarrowPeak: Peaks</H3> <P> The bigNarrowPeak format stores peaks over a range with a single basepair central peak. bigNarrowPeak files are based on the bigBed format. The first six fields are the same as bed. The other four include three scores, and the base-pair offset of the central peak. bigNarrowPeak files are created using the program bedToBigBed with a special AutoSQL file that defines the fields of the bigNarrowPeak. The resulting bigBed files are in an indexed binary format. The main advantage of the bigBed files is that only portions of the files needed to display a particular region are transferred to UCSC. So for large data sets, bigBed is considerably faster than regular BED files. The bigBed file remains on your web accessible server (http, https, or ftp), not on the UCSC server. Only the portion that is needed for the chromosomal position you are currently viewing is locally cached as a "sparse file". For complete bigNarrowPeak format definitions please see the <A HREF="../bigNarrowPeak.html">bigNarrowPeak help page</A>.</P> </DIV> <DIV class="bigMaf_intro"> <H3>bigMaf: Multiple Alignments</H3> <P> The bigMaf format stores multiple alignments in a format compatible with MAF files, which are then compressed and indexed as bigBeds. bigMaf files are created using the program bedToBigBed with a special AutoSQL file that defines the fields of the bigMaf. The resulting bigMaf files are in an indexed binary format. The main advantage of the bigMaf files is that only portions of the files needed to display a particular region are transferred to UCSC. So for large data sets, bigMaf is considerably faster than regular MAF files. The bigMaf file remains on your web accessible server (http, https, or ftp), not on the UCSC server. Only the portion that is needed for the chromosomal position you are currently viewing is locally cached as a "sparse file". For complete bigMaf format definitions please see the