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: principles/fp-012-naming-conventions.md
+18-10Lines changed: 18 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,31 +12,39 @@ GO TO: [Recommendations/Requirements](#recommendations-and-requirements) |
12
12
13
13
## Summary
14
14
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.
16
16
17
17
## Purpose
18
18
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 editors 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.
20
20
21
21
## Recommendations and Requirements
22
22
23
23
Text to be added.
24
+
24
25
For full details, see this paper: <http://www.biomedcentral.com/1471-2105/10/125>
25
26
26
27
Briefly, some important things to remember:
27
28
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
36
41
37
42
## Implementation
38
43
39
44
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
0 commit comments