Skip to main content

Library for working with OBO Library Ontologies and associations

Project description

ontobio - a python API for working with ontology graphs
=======================================================

This module provides objects and utility methods for working with
ontologies and associations of entities (genes, variants, etc) to
ontology classes.

The ontologies and associations can either be local files or provided by
remote services (currently the OntoBee SPARQL service for ontologies and
a Monarch or GO Golr service for associations).

Ontologies
==========

There are two ways of initiating an ontology object:

- via a local obo-json file
- via remote connections to OBO PURLs
- via remote query to a SPARQL service (currently ontobee, but soon
others)

Persistent caching is used (currently cachier) to avoid repeated
expensive I/O connections

This is handled via the `ontol\_manager.py <ontobio/ontol_manager.py>`__
module. This creates an ontology object (see
`ontol.py <ontobio/ontol.py>`__ ).

Note that object modeling is lightweight - we use the python networkx
package for representing the basic graph portion of an ontology. See
also the `obographs <https://github.com/geneontology/obographs>`__ spec.

Associations
============

See the ontobio.golr backage

Command Line Usage
==================

Initial Setup
-------------

::

export PATH $HOME/repos/bioink-api/ontobio/bin
ogr -h

Note you need to be connected to a network

Note: command line interface may change

Connecting to ontologies
------------------------

Specify an ontology with the ``-r`` option. this will always be the OBO
name, for example ``go``, ``cl``, ``mp``, etc

- ``-r go`` connect to GO via default method (currently SPARQL)
- ``-r obo:go`` connect to GO via download and cache of ontology from
PURL
- ``-r /users/my/my-ontologies/go.json`` use local download of ontology

In the following we assume default method, but can be substituted.

Ancestors queries
-----------------

List all ancestors:

::

ogr -r cl neuron

Show ancestors as tree, following only subclass:

::

ogr -r cl -p subClassOf -t tree neuron

generates:

::

% GO:0005623 ! cell
% CL:0000003 ! native cell
% CL:0000255 ! eukaryotic cell
% CL:0000548 ! animal cell
% CL:0002319 ! neural cell
% CL:0000540 ! neuron *
% CL:0002371 ! somatic cell
% CL:0002319 ! neural cell
% CL:0000540 ! neuron *

Descendants of neuron, parts and subtypes

::

ogr -r cl -p subClassOf -p BFO:0000050 -t tree -d d neuron

Descendants and ancestors of neuron, parts and subtypes

::

ogr -r cl -p subClassOf -p BFO:0000050 -t tree -d du neuron

All ancestors of all classes 2 levels down from subclass-roots within
CL:

::

ogr -r cl -P CL -p subClassOf -t tree -d u -L 2

Visualization using obographviz
-------------------------------

Requires: https://www.npmjs.com/package/obographviz

Add og2dot.js to path

::

ogr -p subClassOf BFO:0000050 -r go -t png a nucleus

This proceeds by:

1. Using the python ontobio library to extract a networkx subgraph
around the specified node
2. Write as obographs-json
3. Calls og2dot.js

Output:

.. figure:: https://github.com/biolink/biolink-api/raw/master/ontobio/docs/nucleus.png
:alt: img

img
Search
------

List exact matches to neuron

::

ogr -r cl neuron

Terms starting with neuron, SQL style

::

ogr -r cl neuron%

Terms starting with neuron, regex (equivalent to above)

::

ogr -r cl -s r ^neuron

Terms ending with neuron

::

ogr -r cl -s r neuron$

Terms containing the string neuron

::

ogr -r cl -s r neuron

Note: any of the above can be fed into other renderers, e.g. trees,
graphs

E.g. terms containing neuron, to obo

::

ogr -r cl %neuron% -t obo

E.g. terms ending neuron, to tree

::

ogr -r cl %neuron -t tree



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

ontobio-0.1.2.tar.gz (31.9 kB view details)

Uploaded Source

Built Distributions

ontobio-0.1.2-py3.5.egg (85.4 kB view details)

Uploaded Source

ontobio-0.1.2-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

Details for the file ontobio-0.1.2.tar.gz.

File metadata

  • Download URL: ontobio-0.1.2.tar.gz
  • Upload date:
  • Size: 31.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ontobio-0.1.2.tar.gz
Algorithm Hash digest
SHA256 82ffd5bb4adf07beb406b8147e6a62e054aa07bdd805275de46bd5b232f3ee21
MD5 0dff146c3b3d07e8ae70dcad721d78c6
BLAKE2b-256 7857db55d546ac2985803919fc701c4ba8ee4e60e77b0e3f0fe016ad5f37fc64

See more details on using hashes here.

Provenance

File details

Details for the file ontobio-0.1.2-py3.5.egg.

File metadata

  • Download URL: ontobio-0.1.2-py3.5.egg
  • Upload date:
  • Size: 85.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ontobio-0.1.2-py3.5.egg
Algorithm Hash digest
SHA256 bb1f98793398c9d564f2388722fe7aa569183059fced4df6045875e746d9e894
MD5 1994fdb90134cc6f339b7fd908217507
BLAKE2b-256 f24a20f57c6b1560b8871a354db5900db834de03c1726502015a8ddf12e63d5f

See more details on using hashes here.

Provenance

File details

Details for the file ontobio-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ontobio-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f5ae781317e7f4e438bcf5dea2b679dac7ccc6f0ba12f8d4705d0b0cb57f03d3
MD5 393afba96b48f65c2ca14501fece7425
BLAKE2b-256 2d56e5597c254d1f5d2b84787128bcbc223507015bf75f03602c3639c5bbbf7d

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