Skip to main content

Tool for plotting gene fusion events using Circos.

Project description

FsnViz

https://travis-ci.org/bow/fsnviz.svg?branch=master https://coveralls.io/repos/bow/fsnviz/badge.svg?branch=master&service=github https://badge.fury.io/py/fsnviz.svg

FsnViz is a Python tool for plotting RNA-seq fusion events using Circos plots. It parses outputs of gene fusion finding tools and creates Circos plots out of it.

Currently it accepts outputs of the following gene fusion finding tool:

Requirements

FsnViz runs on Python 3.5 and was tested on Circos 0.69-2. Other Circos versions may or may not work.

Installation

You can download the latest version via pip:

$ pip install fsnviz

Circos needs to be installed separately.

Usage

FsnViz needs only a result file of the gene fusion finding tool:

$ fsnviz star-fusion /path/to/result/file

With the invocation above, it will create the Circos plot as an SVG image called fsnviz.svg in the current directory. You can adjust the output behavior using some flags such as:

  • The --output-dir flag to set the output directory. If it does not exist, it will be created for you.
  • The --base-name flag to set the base name of the Circos plot (the default is fsnviz). Filename extensions are added accordingly.
  • The --karyotype flag to set the Circos reference karyotype. Currently only human.hg19 and human.hg38 are available.

For a complete list, check out the help via fsnviz --help.

Credits

  • Initial circos templates were based on the Circos templates of viewFusion, written by Jiang Li.

License

FsnViz is BSD-licensed. Refer to the LICENSE file for the full license.

History

Versions 0.2

Release 0.2.0

release date: TBD

Versions 0.1

Release 0.1.0

release date: 20 April 2016

  • First release.
  • Support for plotting STAR-fusion output on human.hg19 and human.hg39.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for FsnViz, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size FsnViz-0.1.0.tar.gz (12.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page