Giter Club home page Giter Club logo

fsnviz's Introduction

FsnViz

ci coverage pypi

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.

fsnviz's People

Contributors

bow avatar pyup-bot avatar

Stargazers

biofer avatar

Watchers

James Cloos avatar biofer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.