VICC normalization routine for variations
Project description
Variation Normalization
Services and guidelines for normalizing variation terms into VRS and VRSATILE compatible representations.
Public OpenAPI endpoint: https://normalize.cancervariants.org/variation
Installing with pip:
pip install variation-normalizer
About
Variation Normalization works by using four main steps: tokenization, classification, validation, and translation. During tokenization, we split strings on whitespace and parse to determine the type of token. During classification, we specify the order of tokens a classification can have. We then do validation checks such as ensuring references for a nucleotide or amino acid matches the expected value and validating a position exists on the given transcript. During translation, we return a VRS Allele object.
Variation Normalization is limited to the following types of variants:
- HGVS expressions and text representations (ex:
BRAF V600E):- protein (p.): substitution, deletion, insertion, deletion-insertion
- coding DNA (c.): substitution, deletion, insertion, deletion-insertion
- genomic (g.): substitution, deletion, ambiguous deletion, insertion, deletion-insertion, duplication
- gnomAD-style VCF (chr-pos-ref-alt, ex:
7-140753336-A-T)- genomic (g.): substitution, deletion, insertion
We are working towards adding more types of variations, coordinates, and representations.
Endpoints
/to_vrs
The /to_vrs endpoint returns a list of validated VRS Variations.
The /normalize endpoint returns a Variation Descriptor containing the MANE Transcript, if one is found. If a genomic query is not given a gene, normalize will return its GRCh38 representation.
The steps for retrieving MANE Transcript data is as follows:
- Map starting annotation layer to genomic
- Liftover to preferred GRCh38
We only support lifting over from GRCh37. - Select preferred compatible annotation
- MANE Select
- MANE Plus Clinical
- Longest Compatible Remaining Transcript
- Map back to starting annotation layer
Backend Services
Variation Normalization relies on some local data caches which you will need to set up. It uses pipenv to manage its environment, which you will also need to install.
Once pipenv is installed:
pipenv shell
pipenv lock
pipenv sync
Gene Normalizer
Variation Normalization relies on data from Gene Normalization. You must load all sources and merged concepts.
You must also have Gene Normalization's DynamoDB running for the application to work.
For more information about the gene-normalizer, visit the README.
SeqRepo
Variation Normalization relies on seqrepo, which you must download yourself.
Variation Normalizer uses seqrepo to retrieve sequences at given positions on a transcript.
From the root directory:
pip install seqrepo
sudo mkdir /usr/local/share/seqrepo
sudo chown $USER /usr/local/share/seqrepo
seqrepo pull -i 2021-01-29
UTA
Variation Normalizer also uses uta.
Variation Normalizer uses UTA to retrieve MANE Transcript data.
The following commands will likely need modification appropriate for the installation environment.
-
Install PostgreSQL
-
Create user and database.
$ createuser -U postgres uta_admin $ createuser -U postgres anonymous $ createdb -U postgres -O uta_admin uta -
To install locally, from the variation/data directory:
export UTA_VERSION=uta_20210129.pgd.gz
curl -O http://dl.biocommons.org/uta/$UTA_VERSION
gzip -cdq ${UTA_VERSION} | grep -v "^REFRESH MATERIALIZED VIEW" | psql -h localhost -U uta_admin --echo-errors --single-transaction -v ON_ERROR_STOP=1 -d uta -p 5433
To connect to the UTA database, you can use the default url (postgresql://uta_admin@localhost:5433/uta/uta_20210129). If you use the default url, you must either set the password using environment variable UTA_PASSWORD or setting the parameter db_pwd in the UTA class.
If you do not wish to use the default, you must set the environment variable UTA_DB_URL which has the format of driver://user:pass@host/database/schema.
PyLiftover
Variation Normalizer uses PyLiftover to convert GRCh37 coordinates to GRCh38 coordinates.
Starting the Variation Normalization Service Locally
gene-normalizers dynamodb and the uta database must be running.
To start the service, run the following:
uvicorn variation.main:app --reload
Next, view the OpenAPI docs on your local machine: http://127.0.0.1:8000/variation
Init coding style tests
Code style is managed by flake8 and checked prior to commit.
We use pre-commit to run conformance tests.
This ensures:
- Check code style
- Check for added large files
- Detect AWS Credentials
- Detect Private Key
Before first commit run:
pre-commit install
Testing
From the root directory of the repository:
pytest tests/
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 variation-normalizer-0.4.0a2.tar.gz.
File metadata
- Download URL: variation-normalizer-0.4.0a2.tar.gz
- Upload date:
- Size: 124.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3f75e46d89d6a7e463d9c43a1c26d099f68fdabc9c5c8204bf7b1dff291a41da |
|
| MD5 | 4ea8073198aff7ff53b90266fae73232 |
|
| BLAKE2b-256 | 9fefe40f57e3c0d9d966f1f3e6c84d50939cc22a48d81c4391d7df43d375dc76 |
File details
Details for the file variation_normalizer-0.4.0a2-py3-none-any.whl.
File metadata
- Download URL: variation_normalizer-0.4.0a2-py3-none-any.whl
- Upload date:
- Size: 4.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e2bdd8a3ba021b6f6a79e252ac3a92119f239995ae6689ac7819d9141acd3ed8 |
|
| MD5 | 16d3fea954fd563f00ddc52234e82b9b |
|
| BLAKE2b-256 | de0b57df2f64d638cd33f27080955b88cc9191a34bcd9daa22805a6ff294e777 |
