pySec2Pri 0.1.3 Documentation
pysec2pri maps secondary (retired/withdrawn) biological database identifiers and labels to primary (current) ones, with SSSOM output by default.
Supported databases: ChEBI, HMDB, HGNC, NCBI Gene, UniProt, Wikidata.
Quick Start
Generate a mapping set (CLI):
pysec2pri hgnc ids
pysec2pri chebi synonyms
Update IDs or labels in a file (CLI):
pysec2pri update-ids data.tsv hgnc --at gene_id -o data_primary.tsv
pysec2pri update-labels data.tsv hgnc --at label
# reuse a saved mapping file
pysec2pri update-ids data.tsv hgnc --at gene_id --mapping hgnc_sssom.tsv
Python API:
from pysec2pri import generate_hgnc, resolve_ids
from pysec2pri import generate_hgnc_labels, resolve_labels
from pysec2pri import load_mapping, load_label_mapping
ms = generate_hgnc()
resolve_ids("HGNC:131", ms) # : "HGNC:145"
resolve_ids(["HGNC:131", "HGNC:2"], ms) # : ["HGNC:145", ...]
lms = generate_hgnc_labels()
resolve_labels("BRCA1_OLD", lms) # : "BRCA1"
# load from a saved sec2pri / SSSOM file
ms = load_mapping("hgnc_sec2pri.tsv")
lms = load_label_mapping("hgnc_label2prev.tsv")
Getting Started
API Reference