Tool for plotting gene fusion events using Circos.
Project description
FsnViz
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:
STAR-Fusion hits table (star-fusion)
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file FsnViz-0.1.0.tar.gz
.
File metadata
- Download URL: FsnViz-0.1.0.tar.gz
- Upload date:
- Size: 12.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95901c57769982882db12f08cd8e08d34805a62f1523cc3853862ccc612dd365 |
|
MD5 | 79ba80aeef411b89802e2b3e597b3c37 |
|
BLAKE2b-256 | cbeda9cd233386fab2800e24a5a5b58757c150e35aa0bb30069e44498db4b6a3 |