Thursday, December 27, 2012

URL parameter specification (effective v13)

Last updated: 11/20/2013


To tell which genome assembly to use
parameter namegenome
valueone of hg19, mm9, dm3, tair10, danRer7, spombe201203, AGPv2
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19
notewhen this parameter is used alone, it will load up a blank Browser (with no tracks displayed)
this parameter must be used along with all the rest of the parameters


To retrieve a saved session
parameter namesession
valuethe session ID
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&session=your_session_here 
noteby using this parameter all the following parameters will be neglected


To show data over a specific genomic location
parameter namecoordinate
valuecoordinate must be in form of "chr1:123-456"
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&coordinate=chr7:26663835-28123541
notethis parameter cannot be used when parameter "geneset" is present


To show data over a gene set (or set of genomic intervals)
parameter namegeneset
valuea list of gene symbols, or coordinates, all joined by comma
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&geneset=chr7:26675831-28111542,chr7:101818721-102732764,cyp2c19
notethis parameter cannot be used when parameter "coordinate" is present


To run genomic juxtaposition on a BED track
parameter namejuxtapose
valueif the bed track is native, use internal track name (e.g. "refGene")
else if it is custom bed track, use track URL, a second parameter "juxtaposecustom=on" must also be supplied
examplenative: http://epigenomegateway.wustl.edu/browser/?genome=hg19&juxtapose=refGene
custom: http://epigenomegateway.wustl.edu/browser/?genome=hg19&juxtapose=http://vizhub.wustl.edu/hubSample/hg19/bed.gz&juxtaposecustom=on
note


To display a tabular datahub (deprecated)
parameter namedatahub
valueURL of the hub descriptor file
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&datahub=http://vizhub.wustl.edu/hubSample/hg19/hub2.txt
noteonly one hub URL can be used


To display a JSON datahub
parameter namedatahub_jsonfile
valueURL to the JSON file
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&datahub_jsonfile=http://vizhub.wustl.edu/hubSample/hg19/hub.json
noteonly one hub URL can be used
Refer to this post about how to prepare your JSON datahub.


To add native heatmap tracks (bedgraph/bigwig/categorical)
parameter namehmtk
valuetrack names joined by comma
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&hmtk=GSM469970,GSM521901,GSM521895,GSM521897,GSM469974,GSM521913,GSM469968,GSM521889,GSM945297_2,GSM608165_1,GSM733692_1,GSM788085_1,GSM733776_1,GSM607494_1,GSM945228_2,GSM945228_1
noteuse internal track name, but not the label printed on the left of track image in the browser


To add native genomic annotation tracks
parameter namegftk
valuetrackname1,mode1,trackname2,mode2,...
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&gftk=refGene,full,gc5Base,show
notecurrently, native long-range genome interaction tracks are also declared with this parameter
the mode can never be "hide"
if the track is quantitative, the mode can only be "show",
if the track is positional (bed), the mode can be "thin", "full", "density"
if the track is long-range interaction, mode can be "arc", "trihm", "thin", "full", or "density"


To add native metadata term
parameter namemetadata
valuemetadata terms joined by comma, space in term names must be coded as %20
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&metadata=Histone%20Mark,12003
notenone-leaf terms are shown as "words"
leaf terms must be used as internal ID
If you want to create custom metadata terms, use JSON datahub


To add custom bedGraph track
parameter namecustombedgraph
valuename1,url1,name2,url2,...
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&custombedgraph=track%20No.1,http://vizhub.wustl.edu/hubSample/hg19/qual1.gz,track%20No.2,http://vizhub.wustl.edu/hubSample/hg19/qual2.gz
notespecial characters in the names must be escaped


To add custom bigWig track
parameter namecustombigwig
valuename1,url1,name2,url2,...
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&custombigwig=track%20No.1,http://vizhub.wustl.edu/hubSample/hg19/sample.bigWig,track%20No.2,http://vizhub.wustl.edu/hubSample/hg19/GSM429321.bigWig
notespecial characters in the names must be escaped


To add custom bed track (positional annotations)
parameter namecustombed
valuename1,url1,mode1,name2,url2,mode2,...
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&custombed=bedTrack%20No.1,http://vizhub.wustl.edu/hubSample/hg19/bed.gz,full,bedTrack%20No.2,http://vizhub.wustl.edu/hubSample/hg19/mer41b.gz,full
notemode must be one of "thin", "full", "density"
special characters in the names must be escaped


To add custom long-range interaction track
parameter namecustomlongrange
valuename1,url1,mode1,name2,url2,mode2,....
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&customlongrange=trackname,http://vizhub.wustl.edu/hubSample/hg19/K562POL2.gz,arc
notemode can be one of "arc", "trihm", "thin", "full", "density"
special characters in the names must be escaped


To add custom read-alignment (BAM) track
parameter namecustombam
valuename1,url1,mode1,name2,url2,mode2,...
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&custombam=tempest,http://vizhub.wustl.edu/hubSample/hg19/bam1.bam,density
notemode can be one of "thin", "full", "density"
special characters in the names must be escaped


To show secondary panel (experimental)
parameter namesplinters
valuecoordinate (e.g. chr5:5000000-5100000)
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg19&gftk=gc5Base,show&splinters=chr5:5000000-5100000
notemultiple coordinates can be added, join them by comma. Only use this if your screen is wide enough...


To show default tracks and contents for a genome assembly

parameter namedefaultContent
valuestring "on"
examplehttp://epigenomegateway.wustl.edu/browser/?genome=hg18&defaultContent=on
note



v13: enhanced user interface, architectural overhaul

Happy Holidays to you all! We're very happy to announce a brand new WashU Epigenome Browser. Our goal is to make the User Interface rich in functionality, while keeping it as simple as possible.

Get the code here: from our server, or dropbox
v13 .tgz file does not include folders "images" and "manual", which are available through past version .tgz files


To use the URL parameter function, see instructions in this new post.

To use the datahub function, see instructions in this updated post.


Docs that are not available for the moment:
  1. new interface of scaffold sequence management, Gene Set View (management)
  2. simplified interface of Genome Snapshot (aka Bird's Eye View)
  3. new function: split panel display (for browsing long-range interaction data sets)
  4. improved Circlet View interface



Following screenshot is the part of Browser UI that you often see.



Old Browser is here http://epgg-test.wustl.edu/browser/ in case you need to access your saved sessions. We will keep it alive for two months and alert you before we take it down.



Following is a quick overview of some new features available on the new Browser:


Toolbox as the "single entry point"

Please find the row of three buttons in the middle of toolbox: "Tracks", "CustomTK", and "Apps". This is the entry point to a majority of the Browser's functions.

Tracks refer to the collection of tracks that are available through the Browser service. Clicking on it shows a small menu which leads to the selection panel for each category of tracks:


CustomTK links to the panel for custom track submission and management. Number in the parenthesis is the # of custom tracks you've submitted.

Apps links to the list of applications.



Genome navigation

On top of Browser panel a blue button shows the current coordinate. Click this button to show options to relocate:


Or as indicated, click the button in this small panel to visually select a new region from one of the chromosomes:




Agile track handling
The track labels are always shown on the left of the track images, mouse over the label for complete track name and more info (e.g. color scale bar for the heatmap quantitative tracks)


Press your mouse on the track header and drag it up or down, the track will be rearranged accordingly. You can even drag the heatmap track outside of genome heatmap, or bring a track into the genome heatmap from outside. You're in full control now:




Handy sticky notes
A small but perhaps very useful new feature is the coordinate-anchored sticky notes. It's incredibly easy to use. Just right click on the chromosome ideogram below the genome heatmap, and an input panel appears:


Once a note is made, it is attached to a point in the genome and is indicated by a "note" icon. You can save notes in Session so they are persistent, give it a try!







A few things are still missing here, but we're working to bring these functions back as soon as possible:
  • Pairwise comparison and hypothesis test over quantitative track data
  • Querying and retrieval of KEGG pathway
  • SVG output for Genome Snapshot and Circlet view (previously known as Henge View)