Ontology Metadata Proposal (from OBI) - Revision history

Scheuerm at 15:35, 15 March 2007

2007-03-15T15:35:54Z

Scheuerm at 15:34, 15 March 2007

2007-03-15T15:34:37Z

Scheuerm at 15:33, 15 March 2007

2007-03-15T15:33:47Z

Scheuerm at 15:32, 15 March 2007

2007-03-15T15:32:57Z

Scheuerm at 15:31, 15 March 2007

2007-03-15T15:31:44Z

Scheuerm: New page: !! Minimal requirement for term annotations in the CTO (metadata) The proposed cardinalities are indicated in front of the name of the annotation property. Some are however still under di...

2007-03-15T15:29:26Z

New page: !! Minimal requirement for term annotations in the CTO (metadata) The proposed cardinalities are indicated in front of the name of the annotation property. Some are however still under di...

New page

!! Minimal requirement for term annotations in the CTO (metadata)

The proposed cardinalities are indicated in front of the name of the annotation property. Some are however still under discussion.

! Mandatory metadata: MUST be provided
* 1: *preferred_term*: The concise, meaningful, and human-friendly name for a class or property preferred by the ontology developers. (US-English)
* 1: *definition*: The official CTO definition, explaining the meaning of a class or property. Shall be Aristotelian, formalized and normalized. Can be augmented with informal definitions to further explain the meaning of the term.
* 1,*: *definition_editor*: The name of the editor of the definition.
* 1: *definition_source*: An unambiguous and traceable reference to the source of the definition. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
* 1,*: *curation_status*: The curation status of a class or property. The allowed values come from an enumerated list of predefined terms. Examples: raw import, obo definition incomplete, graph position temporary, uncurated, curation approved
* 1,*: *example*: A phrase describing how a term should be used. May also include other kinds of examples, such as widely known subclasses or instances of the class.
! Optional metadata: SHOULD be provided
* 0,*: *alternative_term*: An alternative name for a class or property which means the same thing, i.e. semantically equivalent, as the preferred_term.
* 0,*: *alternative_term_tag*: A tag to indicate sets of alternative terms. Examples: toxicogenomics_community, abbreviation.
* 0,*: *alternative_term_source*: An unambiguous and traceable reference to the source of the alternative_term. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
* 0,*: *editor_note*: An administrative note intended for the editor. It will not be included in the publication version of the ontology, so it should contain nothing necessary for end users to understand the ontology.
* 0,1: *external_class*: An annotation property that indicates external classes, including their subtrees, for a given anchor class.

@@ Line 4: / Line 4: @@
 Mandatory metadata: MUST be provided
 *preferred_term: The concise, meaningful, and human-friendly name for a class or property  preferred by the ontology developers. (US-English)
-*definition: The official CTO definition, explaining the meaning of a class or property. Shall be Aristotelian, formalized and normalized. Can be augmented with informal definitions to further explain the meaning of the term.
+*definition: The official CTO definition, explaining the meaning of a class or property. Shall be Aristotelian, formalized and normalized. Can be augmented with informal examples to further clarify the meaning of the term.
 *definition_editor: The name of the editor of the definition.
 *definition_source: An unambiguous and traceable reference to the source of the definition. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.

← Older revision		Revision as of 15:34, 15 March 2007
Line 1:		Line 1:
−	Minimal requirement for term annotations in the CTO (metadata)	+	'''Minimal requirement for term annotations in the CTO (metadata)'''

−	~~The proposed cardinalities are indicated in front of the name of the annotation property. Some are however still under discussion.~~

	Mandatory metadata: MUST be provided		Mandatory metadata: MUST be provided

@@ Line 11: / Line 11: @@
 *example: A phrase describing how a term should be used. May also include other kinds of examples, such as widely known subclasses or instances of the class.
 Optional metadata: SHOULD be provided
- *alternative_term*: An alternative name for a class or property which means the same thing, i.e. semantically equivalent, as the preferred_term.
+*alternative_term: An alternative name for a class or property which means the same thing, i.e. semantically equivalent, as the preferred_term.
- *alternative_term_tag*: A tag to indicate sets of alternative terms. Examples: toxicogenomics_community, abbreviation.
+*alternative_term_tag: A tag to indicate sets of alternative terms. Examples: toxicogenomics_community, abbreviation.
- *alternative_term_source*: An unambiguous and traceable reference to the source of the alternative_term. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
+*alternative_term_source: An unambiguous and traceable reference to the source of the alternative_term. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
- *editor_note*: An administrative note intended for the editor. It will not be included in the publication version of the ontology, so it should contain nothing necessary for end users to understand the ontology.
+*editor_note: An administrative note intended for the editor. It will not be included in the publication version of the ontology, so it should contain nothing necessary for end users to understand the ontology.
- *external_class*: An annotation property that indicates external classes, including their subtrees, for a given anchor class.
+*external_class: An annotation property that indicates external classes, including their subtrees, for a given anchor class.

@@ Line 1: / Line 1: @@
-!! Minimal requirement for term annotations in the CTO (metadata)
+Minimal requirement for term annotations in the CTO (metadata)
 The proposed cardinalities are indicated in front of the name of the annotation property. Some are however still under discussion.
-! Mandatory metadata: MUST be provided
+Mandatory metadata: MUST be provided
- * 1: *preferred_term*: The concise, meaningful, and human-friendly name for a class or property  preferred by the ontology developers. (US-English)
+*preferred_term*: The concise, meaningful, and human-friendly name for a class or property  preferred by the ontology developers. (US-English)
- * 1: *definition*: The official CTO definition, explaining the meaning of a class or property. Shall be Aristotelian, formalized and normalized. Can be augmented with informal definitions to further explain the meaning of the term.
+*definition*: The official CTO definition, explaining the meaning of a class or property. Shall be Aristotelian, formalized and normalized. Can be augmented with informal definitions to further explain the meaning of the term.
-  * 1,*: *definition_editor*: The name of the editor of the definition.
+  *definition_editor*: The name of the editor of the definition.
-  * 1: *definition_source*: An unambiguous and traceable reference to the source of the definition. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
+  *definition_source*: An unambiguous and traceable reference to the source of the definition. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
-  * 1,*: *curation_status*: The curation status of a class or property. The allowed values come from an enumerated list of predefined terms. Examples: raw import, obo definition incomplete, graph position temporary, uncurated, curation approved
+  *curation_status*: The curation status of a class or property. The allowed values come from an enumerated list of predefined terms. Examples: raw import, obo definition incomplete, graph position temporary, uncurated, curation approved
-  * 1,*: *example*: A phrase describing how a term should be used. May also include other kinds of examples, such as widely known subclasses or instances of the class.
+  *example*: A phrase describing how a term should be used. May also include other kinds of examples, such as widely known subclasses or instances of the class.
-! Optional metadata: SHOULD be provided
+Optional metadata: SHOULD be provided
-  * 0,*: *alternative_term*: An alternative name for a class or property which means the same thing, i.e. semantically equivalent, as the preferred_term.
+  *alternative_term*: An alternative name for a class or property which means the same thing, i.e. semantically equivalent, as the preferred_term.
-  * 0,*: *alternative_term_tag*: A tag to indicate sets of alternative terms. Examples: toxicogenomics_community, abbreviation.
+  *alternative_term_tag*: A tag to indicate sets of alternative terms. Examples: toxicogenomics_community, abbreviation.
-  * 0,*: *alternative_term_source*: An unambiguous and traceable reference to the source of the alternative_term. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
+  *alternative_term_source*: An unambiguous and traceable reference to the source of the alternative_term. Examples: ISBN, URI plus date, MeSH Term, PUBMED ID, DOI.
-  * 0,*: *editor_note*: An administrative note intended for the editor. It will not be included in the publication version of the ontology, so it should contain nothing necessary for end users to understand the ontology.
+  *editor_note*: An administrative note intended for the editor. It will not be included in the publication version of the ontology, so it should contain nothing necessary for end users to understand the ontology.
-  * 0,1: *external_class*: An annotation property that indicates external classes, including their subtrees, for a given anchor class.
+  *external_class*: An annotation property that indicates external classes, including their subtrees, for a given anchor class.