VICC normalization routines for genes
Project description
Gene Normalizer
Overview
The Gene Normalizer provides tools for resolving ambiguous human gene references to consistently-structured, normalized terms. For gene concepts extracted from NCBI Gene, Ensembl, and HGNC, it designates a CURIE, and provides additional metadata like current and previously-used symbols, aliases, database cross-references and associations, and coordinates.
Documentation · Installation · Usage · API reference
Install
The Gene Normalizer is available on PyPI:
python3 -m pip install gene-normalizer
See installation instruction in the documentation for a description of installation options and data setup requirements.
Examples
Use the live service to programmatically normalize gene terms, as in the following truncated example:
$ curl 'https://normalize.cancervariants.org/gene/normalize?q=BRAF' | python -m json.tool
{
"query": "BRAF",
"match_type": 100,
"gene_descriptor": {
"label": "BRAF",
"gene_id": "hgnc:1097",
"xrefs": [
"ensembl:ENSG00000157764",
"ncbigene:673"
],
"alternate_labels": [
"BRAF1",
"B-RAF1",
"NS7",
"RAFB1",
"B-raf",
"BRAF-1"
]
}
# ...
}
Or utilize the Python API for fast access:
>>> from gene.database import create_db
>>> from gene.query import QueryHandler
>>> q = QueryHandler(create_db())
>>> result = q.normalize("KRAS")
>>> print(result.gene_descriptor.gene_id)
"hgnc:6407"
See the usage and normalization entries in the documentation for more.
Feedback and contributing
We welcome bug reports, feature requests, and code contributions from users and interested collaborators. The documentation contains guidance for submitting feedback and contributing new code.
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 gene-normalizer-0.1.40.dev1.tar.gz.
File metadata
- Download URL: gene-normalizer-0.1.40.dev1.tar.gz
- Upload date:
- Size: 54.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b3fb44f4a24ddc359b37b8d94bacd849409edb15a3850d07d549fbad779bbf58 |
|
| MD5 | dbfd35bc2fbc5d8b81701574e43c5ac5 |
|
| BLAKE2b-256 | 41069b24af9f6dc6b51c73d761ed3f247f6bbe045d53f12be63a911f4710b36b |
File details
Details for the file gene_normalizer-0.1.40.dev1-py3-none-any.whl.
File metadata
- Download URL: gene_normalizer-0.1.40.dev1-py3-none-any.whl
- Upload date:
- Size: 65.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83c237a8e76307057d68e419210c04c98bfeb9de05451801c3d120bd870a74db |
|
| MD5 | 731f7d1a4795f729e098b825ba3a61c8 |
|
| BLAKE2b-256 | 02c7014bd85564d7ae314913cc7c52d420c6bb3356967973a3a2e28c156e8217 |
