ced5bb6f2d3bff2cbb12c8d7a91ec2560868471f dschmelt Thu Jun 13 13:01:29 2019 -0700 Adding hub example and image #15449 diff --git src/hg/htdocs/goldenPath/help/bigGenePred.html src/hg/htdocs/goldenPath/help/bigGenePred.html index bc5537c..a2a3db7 100755 --- src/hg/htdocs/goldenPath/help/bigGenePred.html +++ src/hg/htdocs/goldenPath/help/bigGenePred.html @@ -7,35 +7,34 @@
The bigGenePred format stores positional annotations for collections of exons in a compressed format, similar to how BED files are compressed into bigBeds. The bigGenePred format includes 8 additional fields that contain details about coding frames, annotation status, and other gene-specific information. This is commonly used in the Browser to display start codons, stop codons, and amino acid translations.
Before compression, bigGenePred files can be described as bed12+8 files. bigGenePred
files can be created using the program bedToBigBed
, run with the -as
option to pull in a special
autoSql (.as) file that defines the extra fields of the bigGenePred.
Much like bigBed, bigGenePred files are in an indexed binary format. The advantage of using a binary -format is that only the portions of the file needed to display a particular region are read by the -Genome Browser server. Because of this, indexed binary files have much faster display performance -than regular BED format files when working with large data sets. As with all big files, bigGenePred -files must be hosted on a web-accessible server (http, https, or ftp) to be displayed. For -more information on finding a web-accessible location to host your bigGenePred files, please see +format is that only the portions of the file needed to display a particular region are read, +allowing for much faster performance when working with large data sets. As with all big files, +bigGenePred files must be hosted on a web-accessible server (http, https, or ftp) to be displayed. +For more information on finding a hosting location for your bigGenePred files, please see the hosting section of the Track Hub Help documentation.
The following autoSql definition specifies bigGenePred gene prediction files. This
definition, contained in the file bigGenePred.as,
is pulled in when the bedToBigBed
utility is run with the
-as=bigGenePred.as
option.
table bigGenePred
"bigGenePred gene models"
(
string chrom; "Reference sequence chromosome or scaffold"
uint chromStart; "Start position in chromosome"
@@ -240,30 +239,67 @@
To view this example, you can click this into this Browser link. To view your own data, paste the
link into your web browser and replace the URL after "bigDataUrl=" with a link to your own
hosted data.
http://genome.ucsc.edu/cgi-bin/hgTracks?db=hg38&position=chr19:44905790-44909388&hgct_customText=track%20type=bigGenePred%20bigDataUrl=http://genome.ucsc.edu/goldenPath/help/examples/bigGenePredEx4.bb
You can also add your data in the custom track management
page. This allows you to set position, configuration options, and write a more complete
desciption. If you want to see codons, you can right click, then click configure codon view or
set this options using baseColorDefault=genomicCodons
as is done below.
browser position chr19:44905790-44909388
track type=bigGenePred baseColorDefault=genomicCodons name="bigGenePred Example Four" description="Ex4:BigGenePred Made from GTF" visibility=pack bigDataUrl=http://genome.ucsc.edu/goldenPath/help/examples/bigGenePredEx4.bb
Once you are done, you should have a track on the Genome Browser like the one below.
+
+Example #5: Create a BigGenePred Track Hub
+In this example, you will set up a Track Hub that displays bigGenePred data and uses one of the
+bigGenePred-specific settings to display gene codons. For more instruction on bigGenePred track
+hubs, please visit the
+bigGenePred example description page. For complete instructions on Track Hubs, visit
+the Track Hub set-up page.
+
+- Make sure you have access to a web-hosted file location like GitHub, CyVerse, or an
+institutional website. This is where you will store your bigData files and configuration files.
+For more information, please visit the hosting section of
+our Track Hub help guide.
+- Copy the text from the bigGenePred example hub files
+into files on your hosting website. You will need a hub.txt and a genomes.txt file, along with
+a directory for each assembly you would like to display data on (e.g., hg38). Within your assembly
+directory, you will need your data file(s), (e.g., bigGenePredEHub.bb). Then you will need a
+trackDb.txt file which will define your track settings, such as the setting that displays
+genomic codons and amino acid letters,
baseColorDefault genomicCodons
.
+- Verify that you have the four required files in the following structure, where hg38 is a directory:
+
+--hub.txt
+--genomes.txt
+--hg38
+----trackDb.txt
+----bigGenePred.bb
+
+- Copy the link to your hub.txt file URL of your hub.txt file and paste it into the text input
+box on the Track Hub page. For an example, you can paste
+the following link into the input box:
+
+http://genome.ucsc.edu/goldenPath/help/examples/hubExamples/hubBigGenePred/hub.txt.
+This should connect you to your hub, with the data available by navagating to your
+assembly of interest.
+
+
+
+
Sharing your data with others
If you would like to share your bigGenePred data track with a colleague, learn how to create a URL
link to your data by looking at Example #6 on the
custom track help page.
Extracting data from bigBed format
Because the bigGenePred files are an extension of bigBed files, which are indexed binary files, it
can be difficult to extract data from them. UCSC has developed the following programs to
assist in working with bigBed formats, available from the
binary utilities directory.
-
bigBedToBed
— converts a bigBed file to ASCII BED format.