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

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.2.1.tar.gz (19.7 kB view hashes)

Uploaded source

Built Distribution

mavehgvs-0.2.1-py3-none-any.whl (25.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page