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] [--width WIDTH] [--height HEIGHT] [--noncoding] [--gap GAP] transcript

Description of command.

positional arguments:
  transcript       Transcript (with version) to visualise

optional arguments:
  -h, --help       show this help message and exit
  --width WIDTH    Maximum width of the figure (default: inf)
  --height HEIGHT  Exon height (default: 20)
  --noncoding      Show non coding regions (default: False)
  --gap GAP        Gap between the exons (default: 5)
  --color COLOR    Color for the exons (e.g. 'purple') (default: #4C72B7)

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.=" --width 1024 --color purple > 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 --noncoding --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" --noncoding --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" --noncoding --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.3.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

exonviz-0.1.3-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: exonviz-0.1.3.tar.gz
  • Upload date:
  • Size: 23.7 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.3.tar.gz
Algorithm Hash digest
SHA256 6d024207834db7bf59b8880ae9fde4bfd55be1de32739de9ffa4ab4f1b9cf5e3
MD5 9d073a5f2ffc60c16b49cc6139ea62f4
BLAKE2b-256 f2d3cc78a64f65ab042d08b3ba4d9466aeea0902dc104a64015019e772708f65

See more details on using hashes here.

File details

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

File metadata

  • Download URL: exonviz-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.5 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bc0a1961b2416c3d168c99c2fa5786c8e824f1c8c276eee18a486f1668d409e3
MD5 4cb508515343bde9222af952c9962f0c
BLAKE2b-256 33af977ff54c17438e4da735427bf95d939b9160f1f49d83724d60d1d4b0a005

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