Skip to content

Commit b4bb707

Browse files
natalednlharris
andauthored
Update fp-012-naming-conventions.md (#2891)
* Update fp-012-naming-conventions.md * Update principles/fp-012-naming-conventions.md Co-authored-by: Nomi Harris <nlharris@users.noreply.github.com> --------- Co-authored-by: Nomi Harris <nlharris@users.noreply.github.com>
1 parent 8dcf3d8 commit b4bb707

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

principles/fp-012-naming-conventions.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,39 @@ GO TO: [Recommendations/Requirements](#recommendations-and-requirements) &#124;
1212

1313
## Summary
1414

15-
The names (primary labels) for elements (classes, properties, etc.) in an ontology SHOULD be unique among OBO Foundry ontologies, and MUST be unique within its own ontology.
15+
The names (primary labels) for elements (classes, properties, etc.) in an ontology SHOULD be unique among OBO Foundry ontologies, MUST be unique within its own ontology, and SHOULD be written in accepted format.
1616

1717
## Purpose
1818

19-
Text to be added.
19+
Primary labels are a major mechanism by which terms are referenced. Accordingly, it is important that labels be unique, unambiguous, and formatted for ease of reading and comprehension. Non-unique labels (sometimes for terms that mean very different things) may cause confusion for human users and may prevent some ontology editing tools from full access to terms (for example, when crafting axioms). Labels that are ambiguous cause difficulty when users are trying to identify a term that matches their intention.
2020

2121
## Recommendations and Requirements
2222

2323
Text to be added.
24+
2425
For full details, see this paper: <http://www.biomedcentral.com/1471-2105/10/125>
2526

2627
Briefly, some important things to remember:
2728

28-
- use rdfs:label for the primary label
29-
- include exactly one rdfs:label for every declared entity (e.g. class, property)
30-
- write labels, synonyms, etc as if writing in plain English text. ie use spaces to separate words, only capitalize proper names (e.g. Parkinson disease). Do not use CamelCase, do_not_use_underscores
31-
- avoid extra spaces between words, or at the beginning or end of the term label
32-
- spell out abbreviations. Abbreviations can be included as a separate property.
33-
- make the primary labels to be as unambiguous as possible. Remember, your ontology may be used in a different context than that for which it was originally intended. Remember also of course that the label should be unambiguous without looking at parent terms
34-
- labels MUST be unique within an ontology
35-
- use the IAO property 'obo foundry unique label' [http://purl.obolibrary.org/obo/IAO_0000589](http://purl.obolibrary.org/obo/IAO_0000589) to declare a pan-OBO unique label if required
29+
- There MUST be exactly one rdfs:label for every declared entity (e.g. class, property)
30+
- Labels MUST be unique within an ontology and SHOULD be unique within the wider OBO Foundry
31+
- Format requirements
32+
- Write labels and synonyms using plain English text
33+
- Use spaces to separate words
34+
- Only capitalize proper names (e.g. Parkinson disease)
35+
- Do not use CamelCase
36+
- Do not use under_scores
37+
- Avoid extra spaces between words, or at the beginning or end of the term label
38+
- Spell out abbreviations. Abbreviations can be included as alternative labels (i.e., synonyms)
39+
- Primary labels SHOULD be as unambiguous as possible. An ontology may be used in a context that differs from that for which it was originally intended, including being combined with other ontologies.
40+
- Optimally, each label SHOULD be unambiguous even without looking at parent terms
3641

3742
## Implementation
3843

3944
Text to be added.
45+
- Use rdfs:label for the primary label
46+
- use the IAO property 'obo foundry unique label' [http://purl.obolibrary.org/obo/IAO_0000589](http://purl.obolibrary.org/obo/IAO_0000589) to declare a pan-OBO unique label if required
47+
4048

4149
## Examples
4250

0 commit comments

Comments
 (0)