Skip to content

Commit 45b792c

Browse files
authored
Update StandardizationGuidelines.md
Implement changes discussed in Ops: (1) hide Social Considerations sections; (2) reorder within sections according to importance.
1 parent b29d5ef commit 45b792c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/StandardizationGuidelines.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: doc
33
title: Ontology Standardization Guidelines
44
---
5-
GO TO: [Technical Considerations](#technical-considerations) | [Content-Considerations](#content-considerations) | [Release Considerations](#release-considerations) | [Social Considerations](#social-considerations) | [Communication Considerations](#communication-considerations)
5+
GO TO: [Technical Considerations](#technical-considerations) &#124; [Content Considerations](#content-considerations) &#124; [Release Considerations](#release-considerations)<!-- &#124; [Social Considerations](#social-considerations)--> &#124; [Communication Considerations](#communication-considerations)
66

77
### Technical Considerations
88

@@ -26,18 +26,17 @@ GO TO: [Technical Considerations](#technical-considerations) &#124; [Content-Con
2626
2727
### Content Considerations
2828
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:
30-
- If the NCIt term definition and hierarchical position are reasonable, that term SHOULD be used instead;
31-
- 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;
32-
- 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.
3329
- Use the preferred source for imported terms
3430
- 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.
3531
- Import entire ontologies only when necessary ([tracker item](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/2769))
3632
- 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:
3733
- 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.
3834
- OMO contains commonly used annotation properties.
3935
- RO Core contains the most commonly used relations.
40-
36+
- Use of NCIt terms - If an ontology developer wishes to create a term with a label that already exists in NCIt, the following apply:
37+
- If the NCIt term definition and hierarchical position are reasonable, that term SHOULD be used instead;
38+
- 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;
39+
- 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.
4140
4241
### Release Considerations
4342
@@ -50,7 +49,6 @@ GO TO: [Technical Considerations](#technical-considerations) &#124; [Content-Con
5049
5150
<!-- ### Social Considerations THIS SECTION WILL NOT BE MADE VISIBLE UNTIL CONTENT IS ADDED -->
5251
53-
5452
### Communication Considerations
5553
5654
- 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.

0 commit comments

Comments
 (0)