You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/StandardizationGuidelines.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,13 @@ layout: doc
3
3
title: Ontology Standardization Guidelines
4
4
---
5
5
6
-
### Technical
6
+
### Technical Considerations
7
7
8
8
- Logical consistency of the ontology ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/482))
9
-
- The ontology MUST be **logically consistent**
10
-
- This means (a) there MUST NOT be contradictory statements revealed by reasoning; (b) there MUST NOT be any unsatisfiable classes; and (c) there MUST NOT be any circular definitions.
9
+
- The ontology MUST be **logically consistent**; that is:
10
+
- (a) there MUST NOT be contradictory statements revealed by reasoning;
11
+
- (b) there MUST NOT be any unsatisfiable classes; and
12
+
- (c) there MUST NOT be any circular definitions.
11
13
- This includes when the ontology is classified together with RO, BFO, and COB
12
14
- This also includes when the ontology is classified together with its base dependencies; that is, as part of a 'full' release (see Releases section below)
- Ontologies often include alternatives to term labels (aka synonyms). These can include abbreviations, acronyms, spelling variants, and other types of synonyms. A list of standard synonym types is provided by OMO under the parent Annotation Propery 'SynonymTypeProperty'. Ontology developers that wish to indicate a specific type of synonym SHOULD first consult this list before minting their own. If it is necessary to create a new type, developers SHOULD consider submitting to the OMO controlled vocabulary list indicated above.
23
25
24
-
### Content
26
+
### Content Considerations
25
27
26
28
- NCIt term use - If an ontology developer wishes to create a term with a label that already exists in NCIt, the following apply:
27
29
- If the NCIt term definition and hierarchical position are reasonable, that term SHOULD be used instead;
- Unless necessary, an entire ontology SHOULD NOT be imported if only a subset of terms is needed. To import terms on an individual basis, [ROBOT 'extract'](https://robot.obolibrary.org/extract) and [OntoFox](https://ontofox.hegroup.org/index.php) are useful tools.
- In addition to a set of standards pertaining to release *format* (see [Principle 2](https://obofoundry.org/principles/fp-002-format.html)), the following are the standards pertaining to release *types*, each of which differ with respect to imports, axiomization, and reasoning (see [Release Artefacts](https://oboacademy.github.io/obook/reference/release-artefacts/) for more detailed information):
- *other release artefacts* (OPTIONAL; denoted by PURL ending with ONT-<artefact_type>.owl): These include **non-classified**, **simple**, **basic**, and **simple-non-classified**. See the Release Artefacts link above for details on these.
42
44
- Every ontology MUST provide a 'base' release and MUST provide a 'full' release.
43
45
44
-
### Social
46
+
### Social Considerations
45
47
46
48
47
-
### Communication
49
+
### Communication Considerations
48
50
49
51
- Linking to issue tracker ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/1097)) Any term (or set of terms) with an affiliated issue tracker item (term request or term discussion) SHOULD be linked to the relevant issue(s). Such linking SHOULD use the annotation property 'term tracker item' (IAO:0000233) and SHOULD NOT use a free text comment. The range for 'term tracker item' MUST consist solely of an IRI, without additional text, and the IRI MUST be for the issue tracker item.
0 commit comments