Skip to content

Commit 5ff778e

Browse files
authored
Update StandardizationGuidelines.md
1 parent 7635708 commit 5ff778e

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

docs/StandardizationGuidelines.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ GO TO: [Technical Considerations](#technical-considerations) | [Content-Con
66

77
### Technical Considerations
88

9-
- Logical consistency of the ontology ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/482))
9+
- Ensure the ontology is logical consistent ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/482))
1010
- The ontology MUST be **logically consistent**; that is:
1111
- (a) there MUST NOT be contradictory statements revealed by reasoning;
1212
- (b) there MUST NOT be any unsatisfiable classes; and
1313
- (c) there MUST NOT be any circular definitions.
1414
- This includes when the ontology is classified together with RO, BFO, and COB
1515
- This also includes when the ontology is classified together with its base dependencies; that is, as part of a 'full' release (see [Release Considerations](#release-considerations) section below)
16-
- Ontology root terms annotation ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2149))
16+
- Indicate the root terms of the ontology ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2149))
1717
- Some ontology browsers make use of an ontology-wide annotation property, 'has ontology root term' (IAO:0000700), that governs how the hierarchy is displayed. This helps shield users from having to navigate through not-specific-enough parent terms (such as BFO:0000040 "material entity"). To enable this feature, an ontology SHOULD specify one or more appropriate root terms like so:
1818
```
1919
OWL format:
@@ -26,13 +26,13 @@ GO TO: [Technical Considerations](#technical-considerations) | [Content-Con
2626
2727
### Content Considerations
2828
29-
- NCIt term use - If an ontology developer wishes to create a term with a label that already exists in NCIt, the following apply:
29+
- Use of NCIt terms - If an ontology developer wishes to create a term with a label that already exists in NCIt, the following apply:
3030
- If the NCIt term definition and hierarchical position are reasonable, that term SHOULD be used instead;
3131
- If either the NCIt term definition or the hierarchical position are sub-optimal, the developer MAY create a term in the ontology with an identical label but with a revised definition and subclassing; alternatively such a term MAY be requested of another ontology, if appropriate;
3232
- For case (b), if the definition is based on the NCIt definition, the new term MUST be linked to the original NCIt term to conform to the [NCIt license](https://evs.nci.nih.gov/license) requirements. Note: this does not apply to reuse of term labels.
33-
- Preferred source for imported terms (no tracker item)
33+
- Use the preferred source for imported terms
3434
- Imported terms SHOULD be drawn from the ontology that is the preferred source for the term. The preferred source is usually the ontology with the same ID space as the term, but it can instead be the ontology that currently maintains the term. Importing a term from a secondary source is not recommended because there is no guarantee that the secondary source has the most up-to-date term information, and thus drawing from the original would avoid possible conflicts due to term divergence.
35-
- Whole ontology imports ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2769))
35+
- Import entire ontologies only when necessary ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2769))
3636
- 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. Notable exceptions are imports of small ontologies that provide upper level structure or useful sets of properties:
3737
- BFO (Basic Formal Ontology) or COB (Core Ontology for Biology and Biomedicine) are upper level ontologies used to harmonize multiple OBO Foundry ontologies under the same hierarchy.
3838
- OMO contains commonly used annotation properties.
@@ -41,7 +41,7 @@ GO TO: [Technical Considerations](#technical-considerations) | [Content-Con
4141
4242
### Release Considerations
4343
44-
- Release types ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/482))
44+
- Provide recommended release types ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/482))
4545
- 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):
4646
- **base** (RECOMMENDED; denoted by PURL ending with ONT.owl): Content includes only terms that are owned by the ontology, which include (a) terms using that ontology's prefix; and (b) any terms with a different prefix that are now maintained by that ontology. It does not contain any imports. It does, however, retain references to external ontologies within axioms as needed for definitions and reasoning. Such references, when displayed in Protege, will appear as identifiers only; that is, without labels. Finally, the base will have had reasoning already applied and will be stripped of redundant axioms. **QUESTION: WILL THIS APPLY TO A SPECIFIC REASONER?**
4747
- **full** (REQUIRED; denoted by PURL ending with ONT-full.owl ): Content is as for **base** except that all referenced external terms are present (that is, imports are merged into the **full** release).
@@ -53,6 +53,6 @@ GO TO: [Technical Considerations](#technical-considerations) | [Content-Con
5353
5454
### Communication Considerations
5555
56-
- 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.
56+
- Link terms 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.
5757
5858

0 commit comments

Comments
 (0)