GBrowse

From GMOD
Revision as of 15:12, 4 October 2007 by Clements (Talk | contribs)

Jump to: navigation, search

Description

GBrowse[1] is the most popular viewer in GMOD. For a list of GBrowse and GMOD installations see the GMOD Users page. For a demo of its features, try the WormBase, FlyBase, or Human Genome Segmental Duplication Database web sites.

The Generic Genome Browser is a combination of database and interactive Web page for manipulating and displaying annotations on genomes. Some of its features:

  • Simultaneous bird's eye and detailed views of the genome.
  • Scroll, zoom, center.
  • Attach arbitrary URLs to any annotation.
  • Order and appearance of tracks are customizable by administrator and end-user.
  • Search by annotation ID, name, or comment.
  • Supports third party annotation using GFF formats.
  • Settings persist across sessions.
  • DNA and GFF dumps.
  • Connectivity to different databases, including BioSQL and Chado.
  • Multi-language support.
  • Third-party feature loading.
  • Customizable plug-in architecture (e.g. run BLAST, dump & import many formats, find oligonucleotides, design primers, create restriction maps, edit features)

Documentation


In addition there are many useful HTML files that are created for you when you install the package, including:

Since these are in Perl POD format these files may contain formatting code when viewed in a Web browser.

Downloads

Source Code Download (tar.gz file)

Download the source from the SourceForge download page.

Net-based Installer Script

The net installer script, located at the GBrowse CVS repository will automatically download and install GBrowse and its Perl libraries for you. See Installation for details on using this script.

CVS

There are many new features in the current development version which have not been released yet. To get the latest version, please use anonymous CVS. The recommended branch to use is stable which is more stable than HEAD. Here is the recipe:

% cvs -d :pserver:anonymous@gmod.cvs.sourceforge.net:/cvsroot/gmod login
CVS password: <hit return>
% cvs -d :pserver:anonymous@gmod.cvs.sourceforge.net:/cvsroot/gmod co -r gbrowse-session Generic-Genome-Browser

Once you have successfully checked out the Generic-Genome-Browser distribution, you can simply perform a cvs update inside the directory to get recent changes.

You can also browse the GBrowse CVS.

Installation

  • The network installer script: Generic-Genome-Browser/bin/gbrowse_netinstall.pl
    • You will need to have Perl 5.8.6 or higher, and the Apache web server installed. See the step-by-step instructions below before running the installer for discussion of prerequisites needed. Once these are installed, save the above link to your home directory as gbrowse_netinstall.pl, and then run "perl gbrowse_netinstall.pl". On Windows platforms, you will need to be logged in as a user with administrative privileges. On Mac OSX, Linux or Solaris platforms, you will need to be logged in as root, or to run the command using "sudo" (sudo perl gbrowse_netinstall.pl).

The install script has a few useful options:

   -h|--help            : Show this message
   -d|--dev             : Use the developement version of both GBrowse and bioperl from CVS
   --bioperl_dev        : Use the development version of BioPerl from CVS
   --gbrowse_dev        : Use the development version of GBrowse from CVS
   -b|--build_param_str : Use this string to predefine Makefile.PL parameters 
                          such as CONF or PREFIX for GBrowse installation

So, for example, if you want to install the most recent developments in GBrowse and BioPerl, you can do this:

 sudo perl gbrowse_netinstall.pl -d

This option is useful for getting new options just added to GBrowse (for example, the Balloon pop up windows added before the release of GBrowse 1.69) or for getting a new BioPerl that has recent bugs fixed.

About Databases

GBrowse has a flexible adaptor system for running off various types of database. Standard adaptors include:


Contacts

Please report bugs to the SourceForge Bug Tracker.

Please send questions to the GBrowse mailing list.

References

  1. Cite error: Invalid <ref> tag; no text was provided for refs named PMID:12368253