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] [--color COLOR] [--exonnumber]
               [--firstexon FIRSTEXON] [--lastexon LASTEXON]
               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)
  --exonnumber          Show exon number (default: False)
  --firstexon FIRSTEXON
                        The first exon to draw (default: 1)
  --lastexon LASTEXON   The last exon to draw (default: inf)

Examples

SDHD

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

exonviz SDHD > SDHD.svg

Figure of SDH exons

DMD

For DMD, we explicitly specify the transcript we are interested in. We also set a maximum width for the figure, since DMD has many exons:

exonviz "NM_004006.3" --width 1024 --color purple --exonnumber > 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

You can also input a valid HGVS description on the transcript of interest. The variant will be ignored. Include the non coding regions and increase the height and distance between the exons:

exonviz "NM_000533.5:c.100G>T" --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.4.tar.gz (193.6 kB view details)

Uploaded Source

Built Distribution

exonviz-0.1.4-py3-none-any.whl (187.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: exonviz-0.1.4.tar.gz
  • Upload date:
  • Size: 193.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.4.tar.gz
Algorithm Hash digest
SHA256 428997f128097bab99f328310018cc46c87a00f13b4f947d288218b750b238c0
MD5 3962c8ed373992d942eb6f5fce8cf0b6
BLAKE2b-256 7500cf3305d5682d43f1ba017b34ee54a539f2f4650e75d1e8435f7046a43ed5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: exonviz-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 187.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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 81733e76c80c081afa09333ee8efd13040724ea1716d8f0f5099c23b3e290fe8
MD5 441a15e69c337874f8a735b01a862a36
BLAKE2b-256 ea481b05e15e1b411249f97e9b5f86ae7ad39e928b7ee2e0c2c7bb19856c86c8

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