HGVS Parser, Formatter, Mapper, Validator
Project description
Important: biocommons packages require Python 3.6+. More
The hgvs package provides a Python library to parse, format, validate, normalize, and map sequence variants according to Variation Nomenclature (aka Human Genome Variation Society) recommendations.
Specifically, the hgvs package focuses on the subset of the HGVS recommendations that precisely describe sequence-level variation relevant to the application of high-throughput sequencing to clinical diagnostics. The package does not attempt to cover the full scope of HGVS recommendations. Please refer to issues for limitations.
Information |
     |
Latest Release |
|
Development (main branch) | |
       |
Features
Parsing is based on formal grammar.
An easy-to-use object model that represents most variant types (SNVs, indels, dups, inverstions, etc) and concepts (intronic offsets, uncertain positions, intervals)
A variant normalizer that rewrites variants in canoncial forms and substitutes reference sequences (if reference and transcript sequences differ)
Formatters that generate HGVS strings from internal representations
Tools to map variants between genome, transcript, and protein sequences
Reliable handling of regions genome-transcript discrepancies
Pluggable data providers support alternative sources of transcript mapping data
Extensive automated tests, including those for all variant types and “problematic” transcripts
Easily installed using remote data sources. Installation with local data sources is straightforward and completely obviates network access
Important Notes
You are encouraged to browse issues. All known issues are listed there. Please report any issues you find.
Use a pip package specification to stay within minor releases. For example, hgvs>=1.5,<1.6. hgvs uses Semantic Versioning.
Examples
Installation
By default, hgvs uses remote data sources, which makes installation easy.
$ mkvirtualenv hgvs-test (hgvs-test)$ pip install --upgrade setuptools (hgvs-test)$ pip install hgvs (hgvs-test)$ python
See Installation instructions for details, including instructions for installing Universal Transcript Archive (UTA) and SeqRepo locally.
Configuration
hgvs will use publicly available data sources unless directed otherwise through environment variables, like so:
# N.B. These are examples. The correct values will depend on your installation $ export UTA_DB_URL=postgresql://anonymous:anonymous@localhost:5432/uta/uta_20210129 $ export HGVS_SEQREPO_DIR=/usr/local/share/seqrepo/latest
Alternatively, if you are unable to pass the postgresql password in the UTA_DB_URL environment variable (i.e., generating an auth token), you can set UTA_DB_URL to postgresql://<user>@<host>/<db>/<schema> and set PGPASSWORD. For example:
$ export UTA_DB_URL=postgresql://anonymous@localhost:5432/uta/uta_20210129 PGPASSWORD=anonymous
See the installation instructions for details.
Parsing and Formating
hgvs parses HGVS variants (as strings) into an object model, and can format object models back into HGVS strings.
>>> import hgvs.parser
# start with these variants as strings
>>> hgvs_g = 'NC_000007.13:g.36561662C>T'
>>> hgvs_c = 'NM_001637.3:c.1582G>A'
# parse the genomic variant into a Python structure
>>> hp = hgvs.parser.Parser()
>>> var_g = hp.parse_hgvs_variant(hgvs_g)
>>> var_g
SequenceVariant(ac=NC_000007.13, type=g, posedit=36561662C>T, gene=None)
# SequenceVariants are composed of structured objects, e.g.,
>>> var_g.posedit.pos.start
SimplePosition(base=36561662, uncertain=False)
# format by stringification
>>> str(var_g)
'NC_000007.13:g.36561662C>T'Projecting (“Mapping”) variants between aligned genome and transcript sequences
hgvs provides tools to project variants between genome, transcript, and protein sequences. Non-coding and intronic variants are supported. Alignment data come from the Universal Transcript Archive (UTA).
>>> import hgvs.dataproviders.uta
>>> import hgvs.assemblymapper
# initialize the mapper for GRCh37 with splign-based alignments
>>> hdp = hgvs.dataproviders.uta.connect()
>>> am = hgvs.assemblymapper.AssemblyMapper(hdp,
... assembly_name='GRCh37', alt_aln_method='splign',
... replace_reference=True)
# identify transcripts that overlap this genomic variant
>>> transcripts = am.relevant_transcripts(var_g)
>>> sorted(transcripts)
['NM_001177506.1', 'NM_001177507.1', 'NM_001637.3']
# map genomic variant to one of these transcripts
>>> var_c = am.g_to_c(var_g, 'NM_001637.3')
>>> var_c
SequenceVariant(ac=NM_001637.3, type=c, posedit=1582G>A, gene=None)
>>> str(var_c)
'NM_001637.3:c.1582G>A'
# CDS coordinates use BaseOffsetPosition to support intronic offsets
>>> var_c.posedit.pos.start
BaseOffsetPosition(base=1582, offset=0, datum=Datum.CDS_START, uncertain=False)Translating coding variants to protein sequences
Coding variants may be translated to their protein consequences. HGVS uses the same pairing of transcript and protein accessions as seen in NCBI and Ensembl.
# translate var_c to its protein consequence
# The object structure of protein variants is nearly identical to
# that of nucleic acid variants and is converted to a string form
# by stringification. Per HGVS recommendations, inferred consequences
# must have parentheses to indicate uncertainty.
>>> var_p = am.c_to_p(var_c)
>>> var_p
SequenceVariant(ac=NP_001628.1, type=p, posedit=(Gly528Arg), gene=None)
>>> str(var_p)
'NP_001628.1:p.(Gly528Arg)'
# setting uncertain to False removes the parentheses on the
# stringified form
>>> var_p.posedit.uncertain = False
>>> str(var_p)
'NP_001628.1:p.Gly528Arg'
# formatting can be customized, e.g., use 1 letter amino acids to
# format a specific variant
# (configuration may also be set globally)
>>> var_p.format(conf={"p_3_letter": False})
'NP_001628.1:p.G528R'Normalizing variants
Some variants have multiple representations due to instrinsic biological ambiguity (e.g., inserting a G in a poly-G run) or due to misunderstanding HGVS recommendations. Normalization rewrites certain veriants into a single representation.
# rewrite ins as dup (depends on sequence context)
>>> import hgvs.normalizer
>>> hn = hgvs.normalizer.Normalizer(hdp)
>>> hn.normalize(hp.parse_hgvs_variant('NM_001166478.1:c.35_36insT'))
SequenceVariant(ac=NM_001166478.1, type=c, posedit=35dup, gene=None)
# during mapping, variants are normalized (by default)
>>> c1 = hp.parse_hgvs_variant('NM_001166478.1:c.31del')
>>> c1
SequenceVariant(ac=NM_001166478.1, type=c, posedit=31del, gene=None)
>>> c1n = hn.normalize(c1)
>>> c1n
SequenceVariant(ac=NM_001166478.1, type=c, posedit=35del, gene=None)
>>> g = am.c_to_g(c1)
>>> g
SequenceVariant(ac=NC_000006.11, type=g, posedit=49917127del, gene=None)
>>> c2 = am.g_to_c(g, c1.ac)
>>> c2
SequenceVariant(ac=NM_001166478.1, type=c, posedit=35del, gene=None)There are more examples in the documentation.
Citing hgvs (the package)
Contributing
The hgvs package is intended to be a community project. Please see Contributing to get started in submitting source code, tests, or documentation. Thanks for getting involved!
See Also
Other packages that manipulate HGVS variants:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hgvs-1.5.4.tar.gz.
File metadata
- Download URL: hgvs-1.5.4.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 06abb6363bb0c8ef9f3f8f9dc333d3a346ab5f9ebcb20a5bb56c69256262559f |
|
| MD5 | 9e5fb1a56334792abae168ec5352aac2 |
|
| BLAKE2b-256 | f93515d86f2e862a697626fdfc7c91d6ccf862bdbb7a7c595b428bf9dddb6c3c |
File details
Details for the file hgvs-1.5.4-py2.py3-none-any.whl.
File metadata
- Download URL: hgvs-1.5.4-py2.py3-none-any.whl
- Upload date:
- Size: 107.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 598640bae0de34ff29c58440904fc9156d7a1bc750ddef5894edd415c772b957 |
|
| MD5 | 16cdaa06110fcd3f0d9bc73943906e3f |
|
| BLAKE2b-256 | c8b78950a1ce90093f2f1342cb745d50028553a587f6d0973e1e7a97e364b348 |
