Skip to content

Commit 2986167

Browse files
authored
Update obsolete ontology terms.md
typo + minor edits
1 parent 9aecd7d commit 2986167

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/obsolete ontology terms.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
# Obsoleting and deprecating ontology terms
22
<!--@Document_indicator: Text,links -->
33

4-
Ontologies evolve, terms are revised, split into more detailed terms or deprecated. For proper reusablity of the ontology and traceability of the reason why it was deleted and what is a possible replacement term that should be used instead, the following steps should be adopted.
5-
*(These steps are largely based on the [GO](https://wiki.geneontology.org/index.php/Obsoleting_an_Existing_Ontology_Term) and [ODK](https://ontology-development-kit.readthedocs.io/en/latest/ObsoleteTerm.html) pages for term obsoletion but adjusted for the PMDco.)*
4+
Ontologies evolve, terms are revised, split into more detailed terms or deprecated. For proper reusablity of the ontology and traceability of the reason why it was deleted and what is a possible replacement term that should be used instead, the following obsoletion procedure should be followed.
5+
*(These steps are largely based on the [GO](https://wiki.geneontology.org/index.php/Obsoleting_an_Existing_Ontology_Term) and [ODK](https://ontology-development-kit.readthedocs.io/en/latest/ObsoleteTerm.html) pages for term obsoletion but adopted for the PMDco.)*
66

77
## Check for the PMDco deprecation profile
88
1. Navigate to your local Protégé installation folder and further to '..\conf\deprecation\'
9-
2. Check whether the file 'PMDco.yaml' is present
10-
- if not, download it from [here](https://raw.githubusercontent.com/materialdigital/core-ontology/refs/heads/main/PMDco.yaml) and move it into the Protégé installation folder
9+
2. Check whether the file `PMDco.yaml` is present
10+
- if not, download it from [here](https://raw.githubusercontent.com/materialdigital/core-ontology/refs/heads/main/src/ontology/PMDco.yaml) and move it into the Protégé installation folder
1111

1212
<!--- In the future this should be done without the need for users to manually copy files on their machines. The PMDco deprecation profile may be added to the official protege release or be moved into the respective folder when editing the core or application ontologies. For now this shoould suffice.--->
1313

1414

1515
## Check the usage of the term
1616
1. Check where in the ontology the term is used
17-
- In Protégé, navigate to the term you want to obsolete, go to the Usage tab to see if that ID is used elsewhere.
17+
- In Protégé, navigate to the term you want to obsolete, go to the `Usage` tab to see if that ID is used elsewhere.
1818
- If the term is a parent term or used in logical definitions, **create a substitute term** that replaces the obsolete term.
1919
- Is the obsolete term itself is the replacement or in consideration for other obsoleted terms, update these (with a substitute term) or delete them.
20-
2. Navigate to the term you want to obsolete agin
21-
3. Right-click on the term and select 'Deprecate...' **or** click the 'Edit'-Tab -> 'Deprecrate entity...'
22-
4. Choose the PMDco deprecation profile -> continue
23-
5. Give a reason for deprecation from the list below -> continue
24-
6. (If applicable) Search the substitute term you created earlier, else continue
25-
7. If no substitute term was defined, give one or more terms that can be used as an alternative when possible (if applicable) -> continue -> finish
20+
2. Navigate to the term you want to obsolete again
21+
3. Right-click on the term and select `Deprecate...` **or** click the `Edit`-tab → `Deprecrate entity...`
22+
4. Choose the PMDco deprecation profile from the dropdown menu → continue
23+
- If no PMDco deprecation profile is present, the `PMDco.yaml` is missing from your Protégé installation folder. Checkout the previous section, then return here.
24+
6. Give a reason for deprecation from the list below → continue
25+
7. (If applicable) Search the substitute term you created earlier, else continue
26+
8. If no substitute term was defined, give one or more terms that can be used as an alternative when possible (if applicable) → continue → finish
2627

2728
## Reasons for deprecation
29+
Copy&paste these into the corresponding dialog during the obsoletion procedure.
2830

2931
- original meaning has split and more specific terms were created
3032
- outside of the scope of the ontology

0 commit comments

Comments
 (0)