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 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 .

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.0.tar.gz (316.4 kB view details)

Uploaded Source

Built Distribution

pyobo-0.2.0-py3-none-any.whl (356.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyobo-0.2.0.tar.gz
  • Upload date:
  • Size: 316.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7

File hashes

Hashes for pyobo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1c1ce9d5cf37b9351d5d24b0d9c240a041b1b58420ecebaf86265b1bbd5ec8f5
MD5 6d225fc1cadd8856bf9bd3a45d2e747d
BLAKE2b-256 a7600ccaa58ebdba394749de119cf995e296338b14e9743d0be670ee7f4ef6fb

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pyobo-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 356.9 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/42.0.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7

File hashes

Hashes for pyobo-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23a402a8b63af2e682ae5465b81aad380bee4147181c6b0a5f3af39db7feb408
MD5 d99be6b00b90908f6e5fcf1c7414a11f
BLAKE2b-256 d73413786f9e7e7ccec946d970eed81d08e859c3386afb58fd19c4fee8e41b1d

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