Skip to main content

Visualise exons and their reading frames

Project description

Continous integration Code style: black Checked with mypy

Exonviz

Visualise exons

Installation

Exonviz only requires Python, and can be installed using PIP:

pip install exonviz

Usage

Pass either a transcript (with version!), or a valid HGVS description to exonviz to generate a figure.

Options

Since each gene is different, you will probably want to play around with the options to get the perfect figure for your favorite gene.


usage: exonviz [-h] [--max-width MAX_WIDTH] [--height HEIGHT] [--non-coding]
               [--gap GAP]
               transcript

Description of command.

positional arguments:
  transcript            Transcript (with version) to visualise

optional arguments:
  -h, --help            show this help message and exit
  --max-width MAX_WIDTH
                        Maximum width of the figure (default: inf)
  --height HEIGHT       Exon height (default: None)
  --non-coding          Show non coding regions (default: False)
  --gap GAP             Gap between the exons (default: None)

Examples

SDHD

Using the default settings, which does not include non-coding regions of the exon:

exonviz "NG_012337.3(NM_003002.4):c.274G>T" > SDHD.svg

Figure of SDH exons

DMD

Since DMD has many exons, we specify a maximum width for the figure:

exonviz "NM_004006.3:c.=" --max-width 1024 > DMD.svg

Figure of DMD exons

ATXN1

Include the non coding exons, since most exons of ATXN1 are non coding. We limit the maximum width and increase the height of the picture. For clarity, we also increase the distance between the displayed exons:

exonviz ENST00000436367.6 --non-coding --max-width 4000 --height 150 --gap 50 > ATXN1.svg

Figure of ATXN1 exons

PLP1

Include the non coding regions and increase the height and distance between the exons:

exonviz "NM_000533.5" --non-coding --height 100 --gap 50 > PLP1.svg

Figure of PLP1 exons

NF1

Set the maximum width of the figure to the approximate size of the largest exon:

exonviz "ENST00000358273.9" --non-coding --max-width 3600 --height 75 --gap 20 > examples/NF1-202.svg

Figure of NF1 exons

Project details


Download files

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

Source Distribution

exonviz-0.1.2.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

exonviz-0.1.2-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file exonviz-0.1.2.tar.gz.

File metadata

  • Download URL: exonviz-0.1.2.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for exonviz-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4c9e1943b48307d3dde4e26a3304d0a67a790c804485d298cde85b3a7a027af3
MD5 5576310e371e94cecc419728706cbd10
BLAKE2b-256 37fad0d11f4faa1a0092a95ffb1260afed0ef31653c16fa7622f106adabb0d51

See more details on using hashes here.

File details

Details for the file exonviz-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: exonviz-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for exonviz-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3e9903f434b5b537291de6d8d9561e238d85fe09f78f2d08d7e22c2ba83f6f68
MD5 e93c968cca1c13d804caf62b9bea23a6
BLAKE2b-256 97818a83293e8f87e0695170bcc520e32890ee671208b83157dd26af4c654c62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page