Mondo Curation Workflow Overview¶
This document describes the community curation workflow in Mondo, including how new terms are added to Mondo, when terms are obsoleted, and Mondo releases. An overview of the types of commonly requested changes are depicted below.
Adding new terms to Mondo¶
- New terms are added to Mondo via two processes:
- User requests via our GitHub tracker.
- 'Slurping' from external sources - this is our pipeline to ingest new terms from external sources (such as OMIM, Orphanet), to keep Mondo synched with the external sources.
How to request new terms in Mondo¶
- New term requests should go on our GitHub tracker.
- Guidelines on how to make new term requests are available here
- Alternatively, you may contact us by email or via Slack to inquire about adding a new term. Please email email@example.com with questions or to request to be added to our Slack channel.
- Users are always welcome to join our weekly Curation calls, please email firstname.lastname@example.org and request to be added to the invitation. If should be noted that every new term request will be represented as a GitHub issue. This allows the community to review and comment on these proposed new terms, and offer guidance on classification, definition, etc... This open process ensures transparency and representation of the disease view of the community.
Term Maturity levels, public opinion period, and conflict resolution¶
- Proposed terms: Proposed new terms are publicly shared on our GitHub tracker and labeled with 'new term request'.
- GitHub issues for New Term Request are open for community comment for at least two weeks.
- Provisional terms: New terms are added to Mondo by the Mondo Curation team on a Pull Request (PR). Pull Requests undergo automatic quality control checks and are reviewed by members of the Mondo Curation team to check for accuracy, scientific soundness and other potential mistakes that are not identified by our automatic checks. Similar to GitHub issues, Pull Requests are publicly available and anyone can request changes or make comments on an open PR.
- Pull Requests are merged and new terms are added to the mondo-edit.obo file. At this stage, new terms have a new Mondo ID.
- Mature terms: Mondo is released on a monthly basis around the first of every month. After the Mondo release, the new terms are available in the release files.
- Terms will be visible in OLS approximately a few days after the release.
Obsoleting terms in Mondo¶
Terms in Mondo may be obsoleted for various reasons. Some examples of when to obsolete and/or merge a term are:
Duplicate terms : When terms represent the same concept, these terms will be merged and one of them will be obsoleted in the process (for example MONDO:0019055 mitochondrial disease was obsoleted and replaced by MONDO:0004069 'inborn mitochondrial metabolism disorder')
- Out of scope- Some terms are excluded from Mondo because they are out of scope for Mondo. "Out of scope" criteria are outlined in the exclusion reason table. For example, terms that are not truly diseases, (ie phenotype terms, such as MONDO:0007348 Colchicine resistance). For another example, see see #503.
- obsoleted in source: Sources integrated in Mondo, for example OMIM, Orphanet or GARD, may retire or obsolete a term. For example, MONDO:0015173 obsolete autoimmune enteropathy type 2
phenotype not a disease: The term concept represents a phenotype and not a disease: for example, MONDO:0043606 'obsolete pathologic fracture'
- Obsolete/merge related GitHub issues will remain open for at least two months to allow the community to comment and bring up any objections. All obsoletions will be done via a pull request and reviewed by Mondo developers.
- Terms in the ontology file will be labeled as 'obsoletion candidates' and a proposed date for obsoletion will be added to the term.
- With every Mondo release, we will report the terms that have been obsoleted from Mondo and the new obsoletion candidates (for example, see the 2023-02-06 release notes).
- When a term is tagged for obsoletion, the community has the opportunity to provide input about the potential obsoletion of the term.
- More details about the obsoletion workflow is here.
Request to remove a term from the obsoletion list¶
The community has at least two months to dispute the obsoletion of Mondo terms tagged for obsoletion, or to request a longer period of time before the term obsoletion is done (for example if one needs a longer period to review their annotations). All comment or request should be made by commenting on the GitHub ticket or contact the Mondo Curation team via email or Slack.
- Mondo is released on a monthly basis around the 1st of each month.
- All of the Mondo releases are available here.
- Release notes includes:
- list of all new terms
- list of terms with updated label
- list of terms with changed definitions
- list of obsoleted terms
- list of new obsoletion candidates
- Mondo users are notified of the latest release via our Mondo users email list. To be added to the email list, please contact email us at email@example.com.
The Mondo development team strives to provide an inclusive, community-based development process and we thrive based on our user and community feedback and participation.
In the case that there are disagreements about our development approaches, we will work to resolve the issues. Some approaches include:
- Vetting process by members of the community is done on GitHub issues that are visible to (and can be commented on by) the community
- Open weekly Mondo Curation calls - any member of the community is welcome to join our calls. Please email firstname.lastname@example.org and request to be added to the invitation.
- We host community workshops to discuss larger topics and workflows. A list of past workshops is available here.