Skip to content

Commit

Permalink
update obsoletion documentation (#7505)
Browse files Browse the repository at this point in the history
* update obsoletion documentation

* update doc

* revise text
  • Loading branch information
nicolevasilevsky committed Mar 29, 2024
1 parent 962d92f commit 4b14d9a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/editors-guide/merging-and-obsoleting.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,9 @@ There are 2 ways to merge classes:
1. Rename label to: obsolete [class name]
1. Add annotation **owl:deprecated** and indicate true (in literal)
1. Add annotation **term replaced by** and add ID of term which replaced it (in CURIE format, such as MONDO:0010684). If the disease term is being obsoleted and an HPO term should be used instead, do not use **term replaced by**, rather use the annotation **consider.** For example, see MONDO:0001445.
1. Add an obsoletion reason: use the annotation property 'has obsolescence reason' and manually write in a reason as a string (usually 'out of scope'). Add a source annotation to the obolescence reason that comes from this [list of exclusion reasons](https://mondo.readthedocs.io/en/latest/editors-guide/exclusion-reasons/).
1. Add an obsoletion reason: use the annotation property 'has obsolescence reason' and add `OMO:0001000` in the IRI editor (`OMO:0001000` = out of scope). Add a source annotation to the obsolescence reason that comes from this [list of exclusion reasons](https://mondo.readthedocs.io/en/latest/editors-guide/exclusion-reasons/). It should look something like: `property_value: IAO:0000231 OMO:0001000 {source="MONDO:excludeObsoleteSource"}`.
1. _Optional:_ Add an additional comment (rdfs:comment) explaning why the terms were merged.
1. Add annotation 'term tracker item' (type xsd:anyURI)with a link to the GitHub issue that requested the obsoletion.
1. Add annotation 'term tracker item' (type xsd:anyURI) with a link to the GitHub issue that requested the obsoletion.
1. Remove superclass axioms
1. If the class has children, remove the superclass assertion for the children
1. Example: ![Manual merge example 1](images/github-workflow-manual-merge-1.png)
Expand All @@ -162,8 +162,8 @@ Note: An obsolete Mondo class should not have an xref axiom tagged with "MONDO:e
1. Search for the class to be obsoleted.
1. In the Protege edit menu-> Make entity obsolete
1. Prepend the definition with OBSOLETE. For example, OBSOLETE. Chronic form of myeloproliferative neoplasm.
1. Add an obsoletion reason: use the annotation property 'has obsolescence reason' and manually write in a reason as a string (usually 'out of scope'). Add a source annotation to the obolescence reason that comes from this [list of exclusion reasons](https://mondo.readthedocs.io/en/latest/editors-guide/exclusion-reasons/).
1. Add annotation 'term tracker item' (type xsd:anyURI)with a link to the GitHub issue that requested the obsoletion.
1. Add an obsoletion reason: use the annotation property 'has obsolescence reason' and add `OMO:0001000` in the IRI editor (`OMO:0001000` = out of scope). Add a source annotation to the obsolescence reason that comes from this [list of exclusion reasons](https://mondo.readthedocs.io/en/latest/editors-guide/exclusion-reasons/). It should look something like: `property_value: IAO:0000231 OMO:0001000 {source="MONDO:excludeObsoleteSource"}`.
1. Add annotation 'term tracker item' (type xsd:anyURI) with a link to the GitHub issue that requested the obsoletion.
1. If the term has **database_cross_reference annotations** and the **source** is annotated as MONDO:equivalentTo, change the source to **source** MONDO:obsoleteEquivalent (in the literal tab). Obsolete terms should never be equivalent.
1. Add annotation consider, add the CURIE for the term that should be considered as a replacement.
1. Remove all rare disease subset annotations
Expand All @@ -174,7 +174,7 @@ Note: An obsolete Mondo class should not have an xref axiom tagged with "MONDO:e
1. Rename label to: obsolete [class name].
1. Add annotation **owl:deprecated** and indicate true (in literal).
1. Prepend the definition with OBSOLETE. For example, OBSOLETE. Chronic form of myeloproliferative neoplasm.
1. Add an obsoletion reason: use the annotation property 'has obsolescence reason' and manually write in a reason as a string (usually 'out of scope'). Add a source annotation to the obolescence reason that comes from this [list of exclusion reasons](https://mondo.readthedocs.io/en/latest/editors-guide/exclusion-reasons/).
1. Add an obsoletion reason: use the annotation property 'has obsolescence reason' and add `OMO:0001000` in the IRI editor (`OMO:0001000` = out of scope). Add a source annotation to the obsolescence reason that comes from this [list of exclusion reasons](https://mondo.readthedocs.io/en/latest/editors-guide/exclusion-reasons/). It should look something like: `property_value: IAO:0000231 OMO:0001000 {source="MONDO:excludeObsoleteSource"}`.
1. Add annotation 'term tracker item' (type xsd:anyURI) with a link to the GitHub issue that requested the obsoletion.
1. Remove superclass axioms.
1. If the class has children, remove the superclass assertions for the children.
Expand Down

0 comments on commit 4b14d9a

Please sign in to comment.