JBrowse Desktop

From GMOD
Revision as of 18:05, 14 April 2017 by Colin Diesh (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This page provides a reference guide for "Desktop JBrowse" or "JBrowse Desktop", which is a electron application that was unveiled for the release of JBrowse 1.12.0.

The operation of JBrowse Desktop is comparable to other desktop genome browsers like IGV or IGB, and it can be run without setting up a webserver (most of the time normal jbrowse runs on apache and is viewed in a web browser). In contrast, JBrowse Desktop is a simple exe file that can easily be run locally on Windows or Mac.


Installation

At the most basic level, setting up JBrowse Desktop consists of:

  • Downloading a zip file script from jbrowse.org e.g. from http://jbrowse.org/jbrowse-1-12-1/ and OSX and a Windows version exsits JBrowse-1.12.1-desktop-osx.zip and JBrowse-1.12.1-desktop-win.zip
  • After downloading unzip the file to somewhere. There is no official uninstaller but you can move it to the Program files or Applications directory as needed.

Note: on Mac, you can alternatively use Homebrew and run `brew cask install jbrowse` which will download and place jbrowse in your Application directory


Overview of JBrowse Desktop

When you run JBrowse Desktop you will see a sort of "welcome screen" that gives you several options

  • View "volvox" sample data. A dataset which demonstrates many aspects of jbrowse functions
  • Open sequence file, this allows you to open FASTA, Indexed FASTA (greatly improved performance over regular fasta), or .2bit (same performance as indexed fasta)
  • Open data directory, this allows you to open a data directory that has been prepared with normal jbrowse tools like those that are normally browsed on the web. You can also even point to a URL on the web to open a web based data directory

Indexed FASTA and 2bit can handle arbitrary length sequences, the regular FASTA will run out of memory very fasta


Limitations

  • The "Save session" function will not save some configuration customizations, so if you have advanced customizations it would be recommended to make a data directory by hand the trackList.json and tracks.conf format files
  • If you open a data directory on the web, then "Save session" won't work


Capabilities

  • Can open files from shared network folders and external hard drives on both windows and mac
  • Saves sessions to "application data" folders (normally ~/Library/Electron on osx or \Users\username\Application Data\Electron on windows)

Other links

  • List here


External Links