Browser based application for viewing bam alignments
The website is here and contains full usage instructions, an faq, and a served example.
Copyright (c) 2014 Melissa Gymrek [email protected]
LICENSE: MIT (see LICENSE.txt)
PyBamView requires Python2.6 or greater. The following python packages are required:
Flaskpysampyfaidx
These can all be installed using pip or easy_install. Additionally, the package rsvg-convert is required for exporting alignment snapshots to PDF.
PyBamView can be easily installed using pip: pip install pybamview
To install from source, download or clone the package from github, ensure the required packages are installed, and run python setup.py install from the root directory of the pybamview package.
To use PyBamView, you will need a directory containing indexed BAM files, and optionally a reference genome. All reads in the BAM files must be annotated with a read group. To run, type the command:
pybamview --bamdir $BAMDIR --ref $REF.FA
This will serve pybamview at http://127.0.0.1:5000. Navigate to this URL at your web browser, where you can select samples and start visualizing alignments. Use the --ip and --port to change the host URL and port if desired.
PyBamView can also be used to take alignment "snapshots" from the command line. This requires node.js and npm to be installed (https://nodejs.org/en/) and the libraries d3 and jsdom to be installed. You can install these using:
npm install npm --global
npm install d3 --global
npm install jsdom --global
and setting NODE_PATH to the install location, e.g.:
export NODE_PATH=/usr/local/lib/node_modules/
You can then create snapshots using the snapbam tool, e.g.:
snapbam \
--bam examples/example.sorted.bam \
--regions examples/example_targets.bed \
--zoom 1 \
--samples mysample \
--outdir ~/Desktop/snapshots/ \
--filetype pdf \
--buffer 40 \
--ref hg19.fa
Full usage is available on the pybamview website.