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]
               [--variantcolors VARIANTCOLORS [VARIANTCOLORS ...]]
               [--dump-exons DUMP_EXONS] [--dump-variants DUMP_VARIANTS]
               (--transcript TRANSCRIPT | --exon-tsv EXON_TSV)
               [--variant-tsv VARIANT_TSV]

Visualise exons and mutations

options:
  -h, --help            show this help message and exit
  --width WIDTH         Maximum width of the figure (default: 9999999)
  --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: 9999)
  --variantcolors VARIANTCOLORS [VARIANTCOLORS ...]
                        List of variant colors to cycle through (default:
                        ['#BA1C30', '#DB6917', '#EBCE2B', '#702C8C',
                        '#C0BD7F'])
  --dump-exons DUMP_EXONS
                        Write exons to the specified file (default: None)
  --dump-variants DUMP_VARIANTS
                        Write variants to the specified file (default: None)
  --transcript TRANSCRIPT
                        Transcript (with version) to visualise (default: None)
  --exon-tsv EXON_TSV   TSV file containing exons (default: None)
  --variant-tsv VARIANT_TSV
                        TSV file containing variants (default: None)

Examples

SDHD

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

exonviz --transcript 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 --transcript "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 --transcript 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 --transcript "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 --transcript "ENST00000358273.9" --noncoding --width 3600 --height 75 --gap 20 > 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.2.3.tar.gz (205.7 kB view details)

Uploaded Source

Built Distribution

exonviz-0.2.3-py3-none-any.whl (193.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for exonviz-0.2.3.tar.gz
Algorithm Hash digest
SHA256 4da79557fbb52bbae8d17ec10d4441fec387cab3255bf8399f0f33bbfa9f049b
MD5 2905f6a7e6785feab75024e6af218756
BLAKE2b-256 83c1f760c677c0355cb4e65c134bdb33a4eb30d26e340d2f8b799995430c9fad

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for exonviz-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b94dc551301370152e185c04d7e9264f27a4ad2cd99e87f90e93eb82d7dcf34a
MD5 fefa0352f5cce0afe7aa55ddb9864502
BLAKE2b-256 7631550278cdf1b8c0a8d7ac22fe34aa7f3824ad6bea70bd81d843ef5ffab3f3

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