CGI functions: Difference between revisions

From genomewiki
Jump to navigationJump to search
(making this page about the CGIs for new staff as well as mirror managers)
 
Line 53: Line 53:


===cartDump and cartReset===
===cartDump and cartReset===
These two CGIs will dump and reset your cart, respectively. The cart is what allows the browser to keep track of which assembly, tracks, custom tracks, etc that you are viewing even when you navigate away from a page. cartReset will clear your cart (button on hgGateway and hgTables). cartDump will allow you to view the contents of your cart, which can be useful for debugging.
These two CGIs will dump and reset your cart, respectively. The cart is what allows the browser to keep track of which assembly, tracks, custom tracks, etc you are viewing even when you navigate away from a page. cartReset will clear your cart (button on hgGateway and hgTables). cartDump will allow you to view the contents of your cart, which can be useful for debugging.


===hgApi===
===hgApi===

Revision as of 22:40, 7 July 2011

This page details what each CGI does. Note this is not a complete list of all of our CGIs.

hgGateway

Runs the gateway page (click on genomes in the top blue bar), which allows users to choose which assembly they would like to view (hg19, for example).

hgTracks

Runs the main browser, allowing users to view items in tracks. Also includes track search.

hgc

Gives details about a specific item in a track when an item is clicked on. Runs the detail pages for all tracks except UCSC Genes and UCSC Gene-like tracks (i.e. FlyBase Genes).

hgTrackUi

You can get to this CGI by either clicking on the thin rectangle button to the right of the browser image or on the track name itself. Allows users to configure the track display options and, occasionally, the details displayed by hgc.

hgGene

The details page for UCSC Genes and UCSC Gene-like tracks. You can reach this CGI by clicking on an item in the UCSC Genes track.

hgNear

Runs the Gene sorter (main link in the top blue bar), which allows users to see which genes are related by various criteria.

hgCustom

Allows users to add custom tracks to the browser.

hgVisigene

Runs Visigene (main link in top blue bar from home page), which is a virtual microscope for viewing in situ images.

hgTables

Runs the Table Browser (main link in the top blue bar), which allows users to retrieve the data associated with a track in text format, to calculate intersections between tracks, and to retrieve DNA sequence covered by a track.

hgPal

Shows the protein alignments between species. There are 3 ways to get to the hgPal CGI:

  1. check a "Protein FASTA" click-through from a UCSC Gene details page
  2. check a "CDS FASTA" click-through from a RefSeq Genes details page
  3. using the Table Browser, choose "CDS FASTA" as the output format (this should work for any genePred track)

hgBlat

Runs BLAT (main link in the top blue bar), which allows users to search the genome for a particular DNA, RNA or protein sequence.

hgPcr

Runs In-Silico PCR (main link in the top blue bar), which allows users to see what their PCR product would be given a set of primers.

hgLiftOver

To get to hgLiftOver, go to Home -> Utilities -> Batch Coordinate Conversion (liftOver). Allows users to convert genome coordinates and genome annotation files between assemblies.

hgConvert

Allows users to convert current genome coordinates between assemblies. To access it, click on the "Convert" link in the top blue bar when browsing an assembly.

hgSession

Runs Sessions (main link in the top blue bar), which allows users to configure the browser with specific track combinations, including custom tracks, and save the configuration options.

hgGenome

Runs Genome Graphs (main link in side blue bar from main page), which allows users to see the distribution of the items in a track over the whole genome.

cartDump and cartReset

These two CGIs will dump and reset your cart, respectively. The cart is what allows the browser to keep track of which assembly, tracks, custom tracks, etc you are viewing even when you navigate away from a page. cartReset will clear your cart (button on hgGateway and hgTables). cartDump will allow you to view the contents of your cart, which can be useful for debugging.

hgApi

This CGI is responsible for the metadata "arrow" links on the hgTrackUi page and the "metadata" links on the hgc details pages of composite tracks with metadata.

hgEncodeVocab

After clicking on the metadata "arrow" links on the hgTrackUi page, some of the terms in the metadata are linked to pages describing them. This CGI makes these links possible

hgFileUi

Allows users to interact with the downloads page for certain ENCODE tracks to find files of interest.

hgFileSearch

Runs File Search for ENCODE tracks.

pbGateway, pbGlobal and pbTracks

Runs our Proteome browser (main link in the top blue bar), which allows users look at properties of proteins including sequence, polarity, etc.