Difference between revisions of "JBrowse"

From GMOD
Jump to: navigation, search
m
m (Moving over wholesale to the form version.)
Line 1: Line 1:
 
{{Tool data
 
{{Tool data
 +
|use template=yes
 
|name=JBrowse
 
|name=JBrowse
 
|full name=
 
|full name=
Line 36: Line 37:
 
|integration=
 
|integration=
 
|papers=
 
|papers=
 
+
*JBrowse: a next-generation genome browser <ref name="PMID:19570905" />
PMID: 19570905 - JBrowse: a next-generation genome browser
+
*Setting up the JBrowse genome browser <ref name="PMID:21154710" />
PMID: 21154710 - Setting up the JBrowse genome browser
+
*Visualizing next-generation sequencing data with JBrowse <ref name="PMID:22411711" />
PMID: 22411711 - Visualizing next-generation sequencing data with JBrowse
+
 
|presentations=* April 2013 - Bio-IT World, Robert Buels: [[Media:JBrowse_bioit_world_apr2013.pdf|PDF]]
 
|presentations=* April 2013 - Bio-IT World, Robert Buels: [[Media:JBrowse_bioit_world_apr2013.pdf|PDF]]
 
* August 2012 - presentation given as part of the [[2012 GMOD Summer School]]: [[Media:JBrowse_gmod_aug2012.pdf|PDF]]
 
* August 2012 - presentation given as part of the [[2012 GMOD Summer School]]: [[Media:JBrowse_gmod_aug2012.pdf|PDF]]
Line 48: Line 48:
 
* January 2009 - [[January 2009 GMOD Meeting|GMOD Community Meeting]]: [[ January 2009 GMOD Meeting#JBrowse  | Talk summary ]] | [[:Image:Jan2009JBrowse.pdf|PDF]]
 
* January 2009 - [[January 2009 GMOD Meeting|GMOD Community Meeting]]: [[ January 2009 GMOD Meeting#JBrowse  | Talk summary ]] | [[:Image:Jan2009JBrowse.pdf|PDF]]
 
* July 2008 - [[July 2008 GMOD Meeting|GMOD Community Meeting]]: [[ July 2008 GMOD Meeting#GBrowse 3.0 | Talk summary ]] | [[:Image:GBrowse3GMOD2008.pdf|PDF]]
 
* July 2008 - [[July 2008 GMOD Meeting|GMOD Community Meeting]]: [[ July 2008 GMOD Meeting#GBrowse 3.0 | Talk summary ]] | [[:Image:GBrowse3GMOD2008.pdf|PDF]]
|tutorials=; [[JBrowse Tutorial]] covering installation and configuration
+
|tutorials=
: part of the [[2013 GMOD Summer School]]
+
;[[JBrowse Tutorial]] covering installation and configuration
 +
:part of the [[2013 GMOD Summer School]]
 
;[http://jbrowse.org/code/latest-release/docs/tutorial/ Getting Started with JBrowse Tutorial]
 
;[http://jbrowse.org/code/latest-release/docs/tutorial/ Getting Started with JBrowse Tutorial]
 
:part of the JBrowse documentation
 
:part of the JBrowse documentation
 +
;[[Media:Exploring_structural_variation_in_the_tomato_clade_using_JBrowse.pdf | Exploration of structural variation in the tomato clade using JBrowse]]
 +
:Tutorial explaining how to browse structural variants from the [http://www.tomatogenome.net 150+ tomato genome resequencing project] using JBrowse
 
|getting started preamble=The [http://jbrowse.org/code/latest-release/docs/tutorial/ JBrowse Quick-Start Tutorial] provides a basic step-by-step recipe for quickly getting up and running with JBrowse.
 
|getting started preamble=The [http://jbrowse.org/code/latest-release/docs/tutorial/ JBrowse Quick-Start Tutorial] provides a basic step-by-step recipe for quickly getting up and running with JBrowse.
 
|req=JBrowse requires libpng, Zlib, and GD development libraries, plus make and a C compiler.  On Ubuntu, you can install these prerequisites using the command:
 
|req=JBrowse requires libpng, Zlib, and GD development libraries, plus make and a C compiler.  On Ubuntu, you can install these prerequisites using the command:
Line 96: Line 99:
 
If you are upgrading from a version of JBrowse older than 1.2.0, a fresh installation is required.
 
If you are upgrading from a version of JBrowse older than 1.2.0, a fresh installation is required.
 
|doc=
 
|doc=
http://gmod.org/wiki/JBrowse - main
+
*[http://gmod.org/wiki/JBrowse_Configuration_Guide JBrowse configuration reference]
http://gmod.org/wiki/JBrowse_Configuration_Guide - configuration reference
+
*[http://jbrowse.org/code/latest-release/docs/tutorial JBrowse quick start]
http://jbrowse.org/code/latest-release/docs/tutorial - JBrowse quick start
+
 
|dev ppl=JBrowse is an open-source project, started and managed by the laboratory of '''[mailto:ihh@berkeley.edu Ian Holmes]''' at the [http://berkeley.edu University of California, Berkeley].
 
|dev ppl=JBrowse is an open-source project, started and managed by the laboratory of '''[mailto:ihh@berkeley.edu Ian Holmes]''' at the [http://berkeley.edu University of California, Berkeley].
  
Line 104: Line 106:
  
 
There is a [[#Mailing Lists|mailing list for developers]], and there is usually a teleconference on the 3rd Monday of the month at 2pm Pacific US time.  We welcome participation from anyone and everyone. Please contact [[User:RobertBuels|Robert Buels]] if you would like to listen in or participate.
 
There is a [[#Mailing Lists|mailing list for developers]], and there is usually a teleconference on the 3rd Monday of the month at 2pm Pacific US time.  We welcome participation from anyone and everyone. Please contact [[User:RobertBuels|Robert Buels]] if you would like to listen in or participate.
 
Mitch Skinner
 
Ian Holmes
 
Chris Mungall
 
Lincoln Stein
 
 
|dev status=The [http://github.com/GMOD/jbrowse JBrowse source code repository] is kept on GitHub.  Please feel very free to fork the code on GitHub and make modifications and improvements, submitting pull requests.  GitHub has a very nice [http://help.github.com/fork-a-repo/ tutorial] on how to get started with this style of development.
 
|dev status=The [http://github.com/GMOD/jbrowse JBrowse source code repository] is kept on GitHub.  Please feel very free to fork the code on GitHub and make modifications and improvements, submitting pull requests.  GitHub has a very nice [http://help.github.com/fork-a-repo/ tutorial] on how to get started with this style of development.
 
|dl tracking=
 
|dl tracking=
Line 157: Line 154:
 
|linktitle=The Jane-Ome, medicinal marijuana project
 
|linktitle=The Jane-Ome, medicinal marijuana project
 
}}
 
}}
 
 
 
<!-- to alter this page, please edit the raw data, which is stored at http://gmod.org/wiki/JBrowse/tool_data -->
 
 
{{ :JBrowse/tool_data | template = Template:ToolDisplay }}
 
  
 
[[Category:GMOD Components]]
 
[[Category:GMOD Components]]
 
[[Category:AJAX]]
 
[[Category:AJAX]]
 
[[Category:JBrowse]]
 
[[Category:JBrowse]]

Revision as of 20:50, 29 January 2014

JBrowse logo
Status
  • Mature release
  • Development: active
  • Support: active
Licence
{{{PAGENAME}}} is open source

LGPL, Artistic License 2.0

Resources


About JBrowse

JBrowse is a genome browser with a fully dynamic AJAX interface, being developed as the eventual successor to GBrowse. It is very fast and scales well to large datasets. JBrowse is javascript-based and does almost all of its work directly in the user's web browser, with minimal requirements for the server.

Features

  • Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
  • Scales easily to multi-gigabase genomes and deep-coverage sequencing.
  • Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, VCF (with tabix), REST, and more. BAM, BigWig, and VCF data are displayed directly from the compressed binary file with no conversion needed.
  • Very light server resource requirements. In fact, JBrowse has no back-end server code, just tools for formatting data files to be read directly over HTTP. Serve huge datasets from a single low-cost cloud instance.


Visit the JBrowse website.

Screenshots

JBrowse alignment and coverage.png

Downloads

Using JBrowse

The JBrowse Quick-Start Tutorial provides a basic step-by-step recipe for quickly getting up and running with JBrowse.

System Requirements

JBrowse requires libpng, Zlib, and GD development libraries, plus make and a C compiler. On Ubuntu, you can install these prerequisites using the command:

 sudo apt-get install libpng-dev libgd2-noxpm-dev build-essential

For tips on installing these baseline libraries, see JBrowse Troubleshooting.

Installation

The JBrowse Quick-Start Tutorial provides a basic step-by-step recipe for quickly getting up and running with JBrowse.


1. Download JBrowse onto your web server.

2. Unpack JBrowse into a directory that is served by your web browser. On many systems, this defaults to /var/www.

   cd /var/www
   unzip JBrowse-*.zip

Make sure you have permissions to write to the contents of the jbrowse/ directory you have just created.

3. Run the automated-setup script, ./setup.sh, which will attempt to install all of JBrowse's (modest) prerequisites for you in the jbrowse/ directory itself. Note that setup.sh does not need to be run as root or with sudo. For help troubleshooting failures of setup.sh, see JBrowse Troubleshooting.

4. Visit JBrowse on your machine, substituting the http://(your_machine/path_to_jbrowse)/index.html?data=sample_data/json/volvox. If you can see the included Volvox example data, you are ready to configure JBrowse to show your own data!

Configuration

See the JBrowse Configuration Guide for information on:

Additional topics:

Upgrading JBrowse

To upgrade an existing JBrowse (1.3.0 or later) to the latest version, simply move its data directory (and jbrowse_conf.json if you are using it) into the directory of a newer JBrowse, and the new JBrowse will display that data.

To upgrade a 1.2.x JBrowse, copy its data directory into the new JBrowse directory, and point your browser at compat_121.html in the new JBrowse directory, instead of index.html.

If you are upgrading from a version of JBrowse older than 1.2.0, a fresh installation is required.

Documentation

Publications, Tutorials, and Presentations

Publications on or mentioning JBrowse

  • JBrowse: a next-generation genome browser [1]
  • Setting up the JBrowse genome browser [2]
  • Visualizing next-generation sequencing data with JBrowse [3]

Tutorials

JBrowse Tutorial covering installation and configuration
part of the 2013 GMOD Summer School
Getting Started with JBrowse Tutorial
part of the JBrowse documentation
Exploration of structural variation in the tomato clade using JBrowse
Tutorial explaining how to browse structural variants from the 150+ tomato genome resequencing project using JBrowse

Presentations

Contacts and Mailing Lists

Please direct questions and inquiries regarding JBrowse to the mailing lists below.

Requests for help should be directed to gmod-ajax@lists.sourceforge.net.

Mailing List Link Description Archive(s)
JBrowse gmod-ajax JBrowse help and general questions. Nabble (2010/05+), Sourceforge
jbrowse-dev JBrowse development discussions. Nabble (2011/08+)

gmod-ajax@lists.sourceforge.net

JBrowse in the wild

Public installations of JBrowse:

JBrowse Development

Development team

JBrowse is an open-source project, started and managed by the laboratory of Ian Holmes at the University of California, Berkeley.

As of January 2012, the lead developer of JBrowse is Robert Buels. Most of JBrowse was originally written by Mitch Skinner.

There is a mailing list for developers, and there is usually a teleconference on the 3rd Monday of the month at 2pm Pacific US time. We welcome participation from anyone and everyone. Please contact Robert Buels if you would like to listen in or participate.

Current status

The JBrowse source code repository is kept on GitHub. Please feel very free to fork the code on GitHub and make modifications and improvements, submitting pull requests. GitHub has a very nice tutorial on how to get started with this style of development.

More on JBrowse

See Category:JBrowse


  1. Cite error: Invalid <ref> tag; no text was provided for refs named PMID:19570905
  2. Cite error: Invalid <ref> tag; no text was provided for refs named PMID:21154710
  3. Cite error: Invalid <ref> tag; no text was provided for refs named PMID:22411711
Facts about "JBrowse"RDF feed
Available on platformweb +
Has URLhttp://jbrowse.org/install/ +, http://jbrowse.org +, http://twitter.com/usejbrowse +, http://github.com/GMOD/jbrowse +, http://jbrowse.org/demos +, http://icemangenome.net/%E2%80%8E +, http://genomesunzipped.org/jbrowse +, http://beetlebase.org + and http://www.medicinalgenomics.com/the-jane-ome/ +
Has descriptionJBrowse is a genome browser with a fully dJBrowse is a genome browser with a fully dynamic AJAX interface, being developed as the eventual successor to GBrowse. It is very fast and scales well to large datasets. JBrowse is javascript-based and does almost all of its work directly in the user's web browser, with minimal requirements for the server.

Features[edit]

  • Fast, smooth scrolling and zooming. Explore your genome with unparalleled speed.
  • Scales easily to multi-gigabase genomes and deep-coverage sequencing.
  • Supports GFF3, BED, FASTA, Wiggle, BigWig, BAM, VCF (with tabix), REST, and more. BAM, BigWig, and VCF data are displayed directly from the compressed binary file with no conversion needed.
  • Very light server resource requirements. In fact, JBrowse has no back-end server code, just tools for formatting data files to be read directly over HTTP. Serve huge datasets from a single low-cost cloud instance.ets from a single low-cost cloud instance. + and Browse the genome of Ötzi the ice man +
Has development statusactive +
Has input formatGFF3 +, BED +, FASTA +, WIG +, BedGraph +, Bio::DB::* +, UCSC +, Wiggle +, BigWig + and BAM +
Has licenceLGPL + and Artistic License 2.0 +
Has logoJBrowseLogo.png +
Has software maturity statusmature +
Has support statusactive +
Has titleJBrowse demos +, Ice Man Genome +, Genomes Unzipped: Public Personal Genomics +, BeetleBase + and The Jane-Ome, medicinal marijuana project +
Has topicJBrowse +
Is open sourceYes +
Link typedownload +, website +, social media +, source code +, demo server + and wild URL +
Release date2008 +
Tool functionality or classificationGenome visualization +
Written in languageJavascript + and Perl +
Has subobjectThis property is a special property in this wiki.JBrowse#http://jbrowse.org/install/ +, JBrowse#http://jbrowse.org +, JBrowse#http://twitter.com/usejbrowse +, JBrowse#http://github.com/GMOD/jbrowse +, JBrowse#http://jbrowse.org/demos +, JBrowse#http://icemangenome.net/‎ +, JBrowse#http://genomesunzipped.org/jbrowse +, JBrowse#http://beetlebase.org + and JBrowse#http://www.medicinalgenomics.com/the-jane-ome/ +