Skip to content

Commit 3b48962

Browse files
authored
Update fp-019-term-stability.md
1 parent 811787b commit 3b48962

1 file changed

Lines changed: 26 additions & 5 deletions

File tree

principles/fp-019-term-stability.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Detailed procedures for obsoleting a term are described on the OBO Academy page
4242
3) Remove all existing logical axioms from the term
4343
4) Remove or replace all usages of the term elsewhere in the ontology
4444

45+
It is not necessary (and not advisable) to delete the textual definition.
46+
4547
<i><b>To obsolete a term, the ontology developer</b></i> SHOULD:
4648
1) Indicate any exact term replacement:
4749
- OWL: Use the "term replaced by" annotation property from OMO ([IAO:0100001](http://purl.obolibrary.org/obo/IAO_0100001)) with the value set to the IRI of the relevant term
@@ -59,8 +61,8 @@ Detailed procedures for obsoleting a term are described on the OBO Academy page
5961

6062
1) Prepend the string "OBSOLETE. " (this precise string, including the space) to the term definition. NOTE: This MUST be implemented consistently. That is, if applied at all, it has to be applied to every obsoleted term definition.
6163
2) Indicate the reason(s) for obsoleting:
62-
- OWL: Use the "has obsolescence reason" annotation property from OMO ([IAO:0000231](http://purl.obolibrary.org/obo/IAO_0000231])) with the value set to the IRI of one of the individuals of the "obsolescence reason specification" term [IAO:0000225](http://purl.obolibrary.org/obo/IAO_0000225)
63-
- OBO: ??
64+
- OWL: Use the "has obsolescence reason" annotation property from OMO ([IAO:0000231](http://purl.obolibrary.org/obo/IAO_0000231)) with the value set to the IRI of one of the individuals of the "obsolescence reason specification" term [IAO:0000225](http://purl.obolibrary.org/obo/IAO_0000225)
65+
- OBO: Use "property_value:" with the CURIE for the annotation property (IAO:0000231) and a CURIE for the specific reason (an individual from the "obsolescence reason specification" term [IAO:0000225](http://purl.obolibrary.org/obo/IAO_0000225)). See alternative methods below.
6466

6567
Examples
6668
-------
@@ -85,9 +87,28 @@ OBO:
8587
id: OBI:0001574
8688
name: obsolete cell lysate MHC competitive binding assay using radioactivity detection
8789
def: "OBSOLETE. Competitive inhibition of binding assay measuring MHC ligand binding by radioactivity detection using MHC derived from a cell lysate." []
90+
property_value: IAO:0000231 IAO:0000227
8891
is_obsolete: true
8992
replaced_by: OBI:0001544
9093
```
94+
For OBO format, there are multiple alternatives:
95+
1) Use "relationship:" instead of "property_value:".
96+
1) Use the annotation property label (with underscores) instead of the CURIE "IAO:0000231", and the obsolescence reason label instead of the relevant CURIE. Note that the underscore version of the property label will need to be created in the ontology:
97+
```
98+
[Typedef]
99+
id: has_obsolescence_reason
100+
name: has obsolescence reason
101+
xref: IAO:0000233
102+
is_metadata_tag: true
103+
```
104+
Then:
105+
```
106+
relationship: has_obsolescence_reason IAO:0000227 ! terms merged
107+
```
108+
Or:
109+
```
110+
property_value: has_obsolescence_reason IAO:0000227
111+
```
91112

92113
Counter-example
93114
-------
@@ -97,11 +118,11 @@ The PRO term "phosphoprotein" (PR:000037070) is defined as "A protein that inclu
97118
Criteria for review
98119
-------
99120

100-
TBD
101-
to capture:
121+
TBD - indicate how a human reviewer would go about looking for violations
122+
123+
The technical aspects can be automatically checked:
102124
- ROBOT will give an ERROR if any obsolete term (that is, a term with an "owl:deprecated" property or "is_obsolete: true" tag) does not also have 'obsolete ' prepended to the label.
103125
- If there is at least one term with 'OBSOLETE.' prepended to the definition, ROBOT will WARN if not all obsolete terms are treated consistently.
104-
-OTHERS?
105126

106127
Feedback and Discussion
107128
-------

0 commit comments

Comments
 (0)