Skip to main content

Handling and writing OBO

Project description

Tools for biological identifiers, names, synonyms, xrefs, hierarchies, relations, and properties through the perspective of OBO.

Example Usage

Note! PyOBO is no nonsense. This means that there’s no repetitive prefixes in identifiers. It also means all identifiers are strings, no exceptions.

Note! The first time you run these, they have to download and cache all resources. We’re not in the business of redistributing data, so all scripts should be completely reproducible. There’s some AWS tools for hosting/downloading pre-compiled versions in pyobo.aws if you don’t have time for that.

Get mapping of ChEBI identifiers to names.

import pyobo

chebi_id_to_name = pyobo.get_id_name_mapping('chebi')

name = chebi_id_to_name['132964']
assert name == 'fluazifop-P-butyl'

Or, you don’t have time for two lines

import pyobo

name = pyobo.get_name('chebi', '132964')
assert name == 'fluazifop-P-butyl'

Get reverse mapping of ChEBI names to identifiers

import pyobo

chebi_name_to_id = pyobo.get_name_id_mapping('chebi')

identifier = chebi_name_to_id['fluazifop-P-butyl']
assert identifier == '132964'

Maybe you live in CURIE world and just want to normalize something like CHEBI:132964:

import pyobo

name = pyobo.get_name_by_curie('CHEBI:132964')
assert name == 'fluazifop-P-butyl'

Maybe you’ve got names/synonyms you want to try and map back to ChEBI synonyms. Given the brand name Fusilade II of CHEBI:132964, it should be able to look it up and its preferred label.

import pyobo

prefix, identifier, name = pyobo.ground('chebi', 'Fusilade II')
assert prefix == 'chebi'
assert identifier == '132964'
assert name == 'fluazifop-P-butyl'

# When failure happens...
prefix, identifier, name = pyobo.ground('chebi', 'Definitely not a real name')
assert prefix is None
assert identifier is None
assert name is None

Get xrefs from ChEBI to PubChem

import pyobo

chebi_id_to_pubchem_compound_id = pyobo.get_filtered_xrefs('chebi', 'pubchem.compound')

pubchem_compound_id = chebi_id_to_pubchem_compound_id['132964']
assert pubchem_compound_id == '3033674'

Get xrefs from Entrez to HGNC, but they’re only available through HGNC so you need to flip them

import pyobo

hgnc_id_to_ncbigene_id = pyobo.get_filtered_xrefs('hgnc', 'ncbigene')
ncbigene_id_to_hgnc_id = {
    ncbigene_id: hgnc_id
    for hgnc_id, ncbigene_id in hgnc_id_to_ncbigene_id.items()
}

Get properties, like SMILES. The semantics of these are defined on an OBO-OBO basis.

import pyobo

# I dont make the rules. I wouldn't have chosen this as the key for this property. It could be any string
chebi_smiles_property = 'http://purl.obolibrary.org/obo/chebi/smiles'
chebi_id_to_smiles = pyobo.get_filtered_properties_mapping('chebi', chebi_smiles_property)

smiles = chebi_id_to_smiles['132964']
assert smiles == 'C1(=CC=C(N=C1)OC2=CC=C(C=C2)O[C@@H](C(OCCCC)=O)C)C(F)(F)F'

Installation Current version on PyPI Stable Supported Python Versions MIT License

PyOBO can be installed from PyPI with:

$ pip install pyobo

It can be installed in development mode from GitHub with:

$ git clone https://github.com/pyobo/pyobo.git
$ cd pyobo
$ pip install -e .

Curation of the Metaregistry

At src/pyobo/registries/metaregistry.json is the curated registry. This is a source of information that contains all sorts of fixes for missing/wrong information in MIRIAM, OLS, and OBO Foundry; entries that don’t appear in any of them; additional synonym information for each namespace/prefix; rules for normalizing xrefs and CURIEs, etc.

Most users will be interested in the "database" subdictionary. Each entry has a key that was chosen first by preference for MIRIAM, then OBO Foundry, then OLS, or assigned based on what felt right/was how they appeared in xrefs in other OBO files. Their corresponding entries can have some combination of these keys:

  • title

  • pattern, a regex string for identifiers

  • url, a url pattern to resolve identifiers. Uses $1 to represent the identifier.

  • synonyms, a list of alternative prefixes that should point to this

  • download, a URL to the OBO file in case OBO Foundry doesn’t list it or has a mistake

  • not_available_as_obo, a boolean telling you exactly what it sounds like

  • no_own_terms, a boolean telling you if it is completely derived from external sources

  • wikidata_property, a string pointing to the wikidata property that connects item in WikiData to identifers in this namespace

  • miriam: a dictionary containing “id” and “prefix” to point to MIRIAM

  • obofoundry: a dictionary containing “prefix” to point to OBO Foundry

  • ols, a dictionary containing “ontologyId” to point to OLS

Other entries in the metaregistry:

  • The "remappings"->"full" entry is a dictionary from strings that might follow xref: in a given OBO file that need to be completely replaced, due to incorrect formatting

  • The "remappings"->"prefix" entry contains a dictionary of prefixes for xrefs that need to be remapped. Several rules, for example, remove superfluous spaces that occur inside CURIEs or and others address instances of the GOGO issue.

  • The "obsolete" entry maps prefixes that have been changed.

  • The "blacklists" entry contains rules for throwing out malformed xrefs based on full string, just prefix, or just suffix.

Development

Update the registries with the following commands. These external resources get updated all the time, so don’t forget about this.

$ python -m pyobo.registries.obofoundry
$ python -m pyobo.registries.ols
$ python -m pyobo.registries.miriam

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyobo-0.2.3.tar.gz (330.2 kB view details)

Uploaded Source

Built Distribution

pyobo-0.2.3-py3-none-any.whl (370.1 kB view details)

Uploaded Python 3

File details

Details for the file pyobo-0.2.3.tar.gz.

File metadata

  • Download URL: pyobo-0.2.3.tar.gz
  • Upload date:
  • Size: 330.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for pyobo-0.2.3.tar.gz
Algorithm Hash digest
SHA256 b2e4bf893a7533c3853f96daa4a8ee92f6d2f1fa623874d4f2356025c1c05215
MD5 ccfed5e06c92a120d3f6aff4db6f3411
BLAKE2b-256 c1c63c8f9ddbd162dde3f32dcce31cf3874cb2252b4fd800547410234f1dcfd1

See more details on using hashes here.

Provenance

File details

Details for the file pyobo-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: pyobo-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 370.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for pyobo-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0f5eae6073fb535116b3a954c2f1b79f04e42c8652613f7169a4c880beb59703
MD5 639bd41e207435391404dff1a73024f2
BLAKE2b-256 52b9c6ac012e8f2ff75cb695ed9fa24b2b6e5627c4ad5e120b81e439309799e9

See more details on using hashes here.

Provenance

Supported by

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