Policy for OBO IDSPACE and associated PURL requests
Please raise any questions or concerns on our GitHub tracker: https://github.com/OBOFoundry/OBOFoundry.github.io/issues
Every OBO project has an IDSPACE: a short alphanumeric code that uniquely identifies it among the other OBO projects, e.g. “MOBO”. The IDSPACE is an important part of the project PURLs (Persistent Uniform Resource Locators), which are used to identify individual ontology terms as well as project artifacts such as OWL files.
In order to ensure that there is no IDSPACE redundancy, i.e. only one project/resource is using the IDSPACE “MOBO”, these are allocated by the OBO Foundry Technical Working Group.
The technical working group reserves the right to make decisions based on their experience and judgement. In addition to uniqueness of IDSPACEs, other criteria are for example that there not be overlaps of usage. This includes awareness that there can be the appearance of overlap between accession numbers used in databases and prefixed URIs. For example, we would probably not create a IDSPACE “ISBN” and would instead make alternative suggestions.
Expectations for OBO Membership
Participation in the OBO Foundry implies willingness to discuss your project and collaboratively develop it. You are strongly encouraged to build upon the existing suite of ontologies available in the OBO library.
We recommend projects be orthogonal to each other (i.e. no domain overlap). For those classes that are common across multiple resources (e.g., the class cell) we recommend importing terms from an already existing ontology. Application ontologies (those developed for specific data integration tasks) should reuse terms from existing OBO Foundry domain ontologies. At a minimum, we expect attribution of existing work, specifically through the use of PURLs for individual terms and ontologies.
OBO projects are open and use version control, and so we recommend that you set up an ontology repository on GitHub (or another public version control system). We provide the Ontology Development Kit to help with common ontology development tasks, including the creation of a GitHub repository and appropriate metadata files (see below).
Requirements for OBO Membership
- A project should exist, with work started. We will not “pre-book” IDSPACEs and domains for potential future resources.
- A project must be doing original work within the biological ontology community.
- We will not provide an IDSPACE for a project that is issuing new identifier for existing ontologies.
- If there is clear overlap with an existing domain ontology, you must demonstrate a good faith effort to work with that ontology to provide any new terms needed.
- The required IDSPACE must be available.
- The resource must be publicly available when released. The general expectation is that the ontology source code is available on a public repository such as GitHub.
- There must be a contact person for the resource. The contact person for resources must be subscribed to our main communication channel, the obo-discuss mailing list.
- The requestor and/or contact person should be ready to discuss issues such as whether the ontology is orthogonal, whether there is potential to collaborate with existing efforts.
- It is expected that solicitation of a IDSPACE is done before the IDSPACE is used for identifiers. A common strategy is to develop an ontology, request a IDSPACE, and translate the initial URIs used to the PURLs some time before the initial release. There is no guarantee that you will be granted your IDSPACE, even if you have been using it in your file.
1. Requesting the IDSPACE
Submit your request to our tracker. Select
New Issueand then select
New Ontology Request. Fill out the requested information to the best of your ability.
We expect general discussion to take place on the obo-discuss list, while technical follow-up will take place on the tracker.
Example of such request for ECTO:
Allow up to 4 weeks to give members of the community time to provide feedback and for the Operations Committee to review the request. If you don’t hear back from us after 4 weeks, please follow-up via the tracker issue you created.
Based on this discussion, the Operations Committee will either decline your IDSPACE request, ask for changes, or approve the request.
Once an IDSPACE is approved, two important files must be created. Since your project will be responsible for maintaining these files, it’s best if someone on your team reads our documentation and creates these files. If this is impossible, please let us know on your tracker issue, and one of our volunteers will try to accommodate you.
An OBO PURL configuration file. The OBO PURL system helps maintain links to your ontology terms and artifacts. See purl.obolibrary.org/ for configuration file formatting and how to add your new file.
If you used the Ontology Development Kit to create your ontology, then the required YAML files will be created and stored under
These two files should be created as GitHub Pull Requests (PRs) in the appropriate repository (OBO Foundry Registry for the OBO registry entry and OBO PURLs for the PURL configuration). Once these PRs for these two files are merged, your ontology is officially registered with OBO and your PURLs are available.
As your ontology project grows and changes, be sure to update the OBO registry entry and PURL configuration for your project using GitHub Pull Requests.