Skip to main content

VICC normalization routines for genes

Project description

Gene Normalizer

image image image Actions status DOI

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.


Live service

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": {
        "conceptType": "Gene",
        "id": "normalize.gene.hgnc:1097"
        "primaryCoding": {
            "id": "hgnc:1097",
            "code": "HGNC:1097",
            "system": "https://www.genenames.org/data/gene-symbol-report/#!/hgnc_id/",
        },
        "name": "BRAF",
        "extensions": [
            {
                "name": "aliases",
                "value": [
                    "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")
>>> result.gene.primaryCoding.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.

Project details


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

gene_normalizer-0.11.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gene_normalizer-0.11.1-py3-none-any.whl (64.3 kB view details)

Uploaded Python 3

File details

Details for the file gene_normalizer-0.11.1.tar.gz.

File metadata

  • Download URL: gene_normalizer-0.11.1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gene_normalizer-0.11.1.tar.gz
Algorithm Hash digest
SHA256 a6d3ecfae5da2354d94ac67fb1ce2d49bdfda11f293827b4b47418994af33a0e
MD5 7f65d1f67a96931fc006179b8c028aa9
BLAKE2b-256 ce2203fce788257b9effac86f0b4a2d3ff2ea6bf9dfe08c5acc83195fd7905ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for gene_normalizer-0.11.1.tar.gz:

Publisher: release.yml on cancervariants/gene-normalization

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gene_normalizer-0.11.1-py3-none-any.whl.

File metadata

File hashes

Hashes for gene_normalizer-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f426c70fc4d6811d04db9e54ec834da7ea509c7b438f2e231161f110ed85e435
MD5 9d618cd540abb187d0c14ceb4859d736
BLAKE2b-256 e63420e3f223cdbc90a3ab36460eb1de985bbe3c59b3fcf20bc019097fbaf43a

See more details on using hashes here.

Provenance

The following attestation bundles were made for gene_normalizer-0.11.1-py3-none-any.whl:

Publisher: release.yml on cancervariants/gene-normalization

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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