Skip to main content

Regular expression-based validation of HGVS-style variant strings for Multiplexed Assays of Variant Effect.

Project description

Build Status Coverage Status Code style: black

mavehgvs

mavehgvs is the Python reference implementation of the MAVE-HGVS variant representation standard, a strict subset of HGVS, used primarily for clinical genomics.

The MAVE-HGVS Standard

MAVE-HGVS is a strict subset of the HGVS Sequence Variant Nomenclature, version 20.05. HGVS nomenclature is comprehensive and very expressive and consequently includes a lot of syntax that is not needed to represent variants from Multiplexed Assay of Variant Effect (MAVE) data and makes the variant strings more challenging to parse.

While packages exist for parsing HGVS (most notably the biocommons hgvs package, they are intended for use in human genetics and rely on sequence databases and reference sequence (called "target sequence" for MAVE-HGVS), which are not always available for or relevant for multiplexed assays.

MAVE-HGVS is an attempt to define an easy-to-parse subset of the HGVS nomenclature that captures those variants that occur in MAVE datasets, while excluding many variant types that are unlikely to be found. Importantly, the mavehgvs implementation does not rely on external sequence databases or identifiers.

Supported Variants

MAVE-HGVS supports DNA, RNA, and protein variants. MAVE-HGVS supports a subset of HGVS variants including:

  • substitutions
  • deletions
  • duplications
  • insertions
  • frame shifts

Many HGVS variants are unsupported including:

  • inversions
  • conversions
  • extensions
  • changes in methylation state
  • RNA fusion transcripts
  • mosaicism
  • chimerism
  • variants with uncertain consequence
  • variants in trans or unknown phase
  • complex variants (e.g. translocations)

For further details, including example variants, see the specification in the package documentation.

Installation

Install mavehgvs from pip using:

pip3 install mavehgvs

To set up the package for development purposes, include the optional dependencies and install pre-commit:

pip3 install mavehgvs[dev]
pre-commit install

Feedback

To report a problem or request a new feature with either the mavehgvs package or the MAVE-HGVS standard, please use the GitHub issue tracker.

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

mavehgvs-0.7.0.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

mavehgvs-0.7.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file mavehgvs-0.7.0.tar.gz.

File metadata

  • Download URL: mavehgvs-0.7.0.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for mavehgvs-0.7.0.tar.gz
Algorithm Hash digest
SHA256 09cc3311b6ccf53a3ce3e474611af9e28b87fa02b8e690343f99a85534f25eae
MD5 d94cd36d41280bb1546f469537977b06
BLAKE2b-256 59021e5c1c578fae58b541456dae6643e69633c05c3d2b4adaa5ed8e150910c6

See more details on using hashes here.

File details

Details for the file mavehgvs-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: mavehgvs-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for mavehgvs-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a89d2ee16cf18a6a6ecfc2b6f5e280c3c699ddfe106b4389540fb0423f98e922
MD5 fbc1d35affb5b5acc1632eecaaf66fc2
BLAKE2b-256 52560ccc60eb645c1488b7d92ce4597688c92ea5045efc01a1ae8f46f0a3d138

See more details on using hashes here.

Supported by

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