Biomappings

Community curated and predicted equivalences and related mappings between named biological entities that are not available from primary sources.

💾 Data

The data are available through the following three files on the biomappings/biomappings GitHub repository.

These data are available under the CC0 1.0 Universal License.

Equivalences and related mappings that are available from the OBO Foundry and other primary sources can be accessed through Inspector Javert's Xref Database on Zenodo which was described in this blog post.

📊 Summary

A summary is automatically generated nightly with GitHub Actions and deployed to https://biomappings.github.io/biomappings/.

The equivalences are also available as a network through NDEx.

⬇️ Installation

The most recent release can be installed from PyPI with:

$ pip install biomappings

The most recent code and data can be installed directly from GitHub with:

$ pip install git+https://github.com/biomappings/biomappings.git

To install in development mode, use the following:

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

Usage

There are three main functions exposed from biomappings. Each loads a list of dictionaries with the mappings in each.

import biomappings

true_mappings = biomappings.load_mappings()

false_mappings = biomappings.load_false_mappings()

predictions = biomappings.load_predictions()

Alternatively, you can use the above links to the TSVs on GitHub in with the library or programming language of your choice.

🙏 Contributing Curations

GitHub Web Interface

GitHub has an interface for editing files directly in the browser. It will take care of creating a branch for you and creating a pull request. After logging into GitHub, click one of the following links to be brought to the editing interface:

• True Mappings
• False Mappings
• Predictions

This has the caveat that you can only edit one file at a time. It's possible to navigate to your own forked version of the repository after, to the correct branch (will not be the default one), then edit other files in the web interface as well. However, if you would like to do this, then it's probably better to see the following instructions on contributing locally.

Locally

1. Fork the repository at https://github.com/biomappings/biomappings, clone locally, and make a new branch
2. Edit one or more of the resource files (mappings.tsv, incorrect.tsv, predictions.tsv)
3. Commit to your branch, push, and create a pull request back to the upstream repository.

🌐 Web Curation Interface

Rather than editing files locally, this repository also comes with a web-based curation interface. Install the code in development mode with the web option (which installs flask and flask-bootstrap) using:

$ git clone git+https://github.com/biomappings/biomappings.git
$ cd biomappings
$ pip install -e .[web]

The web application can be run with:

$ biomappings web

It has a button for creating commits, but you'll also have to make pushes from the repository yourself after reviewing the changes.

Note if you've installed biomappings via PyPI, then running the web curation interface doesn't make much sense, since it's non-trivial for most users to find the location of the resources within your Python installation's site-packages folder, and you won't be able to contribute them back.

⚖️ License

Code is licensed under the MIT License.