Difference between revisions of "Resources for Data Contributors"

From phenoscape
(→‎Proper syntax for relative length)
 
(119 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
==Viewing ontologies==
+
The following instructions outline the resources used by Phenoscape curators for the annotation of evolutionary phenotypes.  If you are a student intern, please refer to the [http://phenoscape.org/wiki/Student_Instructions Student Instructions] page for more information and links.
  
−
===On the web===
+
Data uploaded to the Phenoscape Knowledgebase are made available under a Creative Commons Attribution 3.0 Unported license (see [[Phenoscape data policy]])
  
−
Many ontologies are available for browsing at the [http://www.bioontology.org/ncbo/faces/index.xhtml NCBO BioPortal].  For example:
+
==1. Download Most Recent Version of Phenex==
−
* [http://www.bioontology.org/ncbo/faces/pages/ontology_details.xhtml?ontology_display_name=Zebrafish%20anatomy%20and%20development Zebrafish anatomy and development]
 
−
* [http://www.bioontology.org/ncbo/faces/pages/ontology_details.xhtml?ontology_display_name=PATO PATO]
 
−
Click the "Visualize" button on the ontology's homepage to browse it graphically.
 
  
−
Other ontologies:
+
Phenex was developed by Phenoscape for annotation of evolutionary phenotypes.  You can find instructions for downloading and installing Phenex at the [[Phenex|'''Phenex homepage''']].
−
* [http://www.obofoundry.org/ro/ OBO-relations]
 
  
−
The teleost [[taxonomy ontology|taxonomy]] and anatomy ontologies is now available:
+
==2. Access Project Files==
−
* [http://www.bioontology.org/ncbo/faces/pages/ontology_details.xhtml?ontology_display_name=Teleost%20taxonomy Teleost taxonomy]
 
−
* [http://www.bioontology.org/ncbo/faces/pages/ontology_details.xhtml?ontology_display_name=Teleost%20anatomy%20and%20development%20(TAO) Teleost Anatomy Ontology (TAO)]
 
  
−
It is generated, with some modifications, from: [http://www.calacademy.org/RESEARCH/ichthyology/catalog/fishcatsearch.html Catalog of Fishes].
+
Phenoscape project files are XML files (more specifically, they are in [http://nexml.org NeXML] format) created using Phenex and available on GitHub at https://github.com/phenoscape/phenoscape-data.
  
−
===On your desktop===
+
==3. Access PDFs for Curation ==
  
−
You can download the ontologies as OBO files from the above web sites.  You can download and install [http://oboedit.org/ OBO-Edit] to view in a desktop application.
+
Phenoscape maintains a collection of PDFs for curation. Please ask project personnel (Wasila or Paula) for access to the collection.
  
−
==Annotating phenotypes==
+
==4. Use Ontologies to Annotate Characters ==
  
 +
The primary activity of a curator is to annotate the free-text characters from systematic studies using ontologies.  Instructions for this activity can be found in the [[Guide to Character Annotation | '''Phenoscape Guide to Character Annotation''']].
  
 +
==5. Update Taxon Lists==
  
−
===Phenote===
+
Most project files require a taxonomic expert to review the taxonomy used in a publication and update to reflect current taxonomy. Please see instructions for [[Creating Taxon Lists| '''creating taxon lists''']] in Phenex or instructions for [[Update Taxon Lists| '''updating taxon lists''']] with valid taxon names.
  
−
[http://www.phenote.org/ Phenote] is used by ZFIN and FlyBase for mutant phenotype annotation.  We are developing enhancements to the Phenote [[EQ Editor]] for PhenoScape data curation.  Some of the PhenoScape-specific enhancements include:
+
==6. Request New Terms for Ontologies==
  
−
* [[Phenote:Specimen List|A specimen list window]] allowing repeated annotation of the specimens within one publication.
+
Curation drives ontology development and many new terms and relationships need to be added. Submit requests for updates to the ontologies used in Phenoscape to the following term trackers:
−
* [[Phenote:Phylogeny Chooser|A phylogeny view]] allowing application of an EQ annotation to all specimens from a clade at once.
 
  
−
====Installation and start up====
+
* [https://github.com/cmungall/uberon/issues Uber Anatomy Ontology (Uberon) term tracker]
 +
* [http://sourceforge.net/tracker/?group_id=76834&atid=595654 Phenotype and Trait Ontology (PATO) term tracker]
 +
* [http://sourceforge.net/tracker/?group_id=224046&atid=2519810 Vertebrate Taxonomy Ontology (VTO) term tracker]
 +
* [http://phenoscape.org/wiki/Ontologies#Fish_Collection_Codes_Vocabulary Collection Codes Vocabulary]
  
−
* You need Java 1.5 or newer to run Phenote. For the Mac this requires Mac OS X 10.4 or newer.
+
==7. Edit the Anatomy Ontology ==
−
* Launch Phenote using the [http://www.phenote.org/phenote/latest/phenote.jnlp webstart link].  Alternatively, you can try the in-progress builds with the latest features, packaged for [https://www.nescent.org/wg/phenoscape/images/4/40/Phenote-MacOSX.zip Mac OS X] or [https://www.nescent.org/wg/phenoscape/images/d/db/Phenote-Windows.zip Windows].
+
* [http://phenoscape.org/wiki/Ontology_workflow Ontology Editing Guidelines]
−
* Choose the "phenomap" configuration before beginning (this will soon be replaced by a "phenoscape" config).
 
−
* So far most curators are using the Excel-compatible tab-delimited format for saving files.
 
  
−
====Usage====
+
==8. Subscribe to Curator and Ontology Request Mailing Lists ==
 +
* Discussion of ontology development and Open Biomedical Ontologies community issues  ''[https://groups.google.com/forum/#!forum/obo-discuss obo-discuss]
  
−
The following table describes the entry fields in the PhenoScape configuration.  Phenote does not force you to fill in them all, but see the table for when to use each field.
+
[[Category:Curation]]
−
 
+
[[Category:Help]]
−
{| border="1" cellspacing="0" cellpadding="3"
 
−
! Field
 
−
! Usage
 
−
|-
 
−
| Publication || the publication describing the character state<br/>CrossRef has a [http://www.crossref.org/SimpleTextQuery/ free-text query form] for looking up DOIs
 
−
|-
 
−
| Taxon || Genus & species
 
−
|-
 
−
| Catalog Number || museum lot ID
 
−
|-
 
−
| Specimen Count || number of specimens from lot examined
 
−
|-
 
−
| Preparation || type of specimen preparation (skeleton, cleared & stained, etc.)
 
−
|-
 
−
| Entity || term from anatomy ontology (currently using zebrafish)
 
−
|-
 
−
| Quality || term from PATO - should be "value" term, unless you are filling in an absolute measurement (e.g. "length")
 
−
|-
 
−
| Additional Entity || term from anatomy ontology - only use if the Quality term descends from "relational quality of continuant"
 
−
|-
 
−
| Measurement || absolute measurement - useful as value for terms such as "length"
 
−
|-
 
−
| Unit || unit of measurement, if Numerical Value is filled in
 
−
|-
 
−
| Compare To || a taxon to which this phenotype is in comparison to (optional)
 
−
|-
 
−
| Textual Description || textual description of character state in publication
 
−
|-
 
−
| Image URI || web link to an image, if available
 
−
|}
 
−
 
 
−
Please report any issues you come across by using the [https://sourceforge.net/tracker/?group_id=76834&atid=887913 Phenote tracker].
 
−
 
 
−
===Term post-composition and pre-coordination===
 
−
 
 
−
Terms can be post-composed at the time of annotation rather than pre-composed (also known as pre-coordinated) within the ontology. Post-composed terms are created in Phenote and follow genus-differentia definitions. Unlike pre-composed terms, do not have an ID.
 
−
 
 
−
=====Post-composition=====
 
−
 
 
−
''Example 1'': ‘branched dorsal fin ray’
 
−
 
 
−
E= TAO: dorsal fin lepidotrichium^has_quality(PATO:branched)
 
−
 
 
−
''Example 2'': ‘supraorbital ventral projection’
 
−
 
 
−
bony projection^part_of [(ventral region)^part_of (supraorbital bone)]
 
−
 
 
−
Ea= TAO: bony projection
 
−
 
 
−
Eb= BSPO: ventral region part_of TAO: supraorbital bone
 
−
 
 
−
 
 
−
Post-composition in Phenote is enabled using the ‘comp’ button next to the Entity field.  In example 1, the genus term is ‘dorsal fin lepidotrichium’ and the differentia term is ‘branched.’  The term in example 2 requires nesting because term Eb is a post-composed term (it is not an ‘additional entity’).
 
−
 
 
−
=====Pre-composition=====
 
−
The above term would be pre-coordinated using OBO-edit as:
 
−
 
 
−
TAO: supraorbital ventral projection
 
−
 
 
−
intersection of TAO: bony projection
 
−
 
 
−
intersection of TAO: ventral region of suprorbital
 
−
 
 
−
TAO: ventral region of suprorbital
 
−
 
 
−
intersection of BSPO: ventral region
 
−
 
 
−
intersection of TAO: suprorbital
 
−
 
 
−
====Known Issues:====
 
−
The post-compose feature in Phenote allows addition of multiple differentia that apply to the initial genus term but nesting of terms is not yet enabled. In the meantime, when post-composed terms that require nesting are needed for annotation, we will note in the 'curator notes' field that these terms will need proper updating once nesting is possible.
 
−
 
 
−
==Curatorial Best Practices==
 
−
===Genus-differentia definitions===
 
−
 
 
−
Term definitions in the teleost anatomy ontology (TAO) take the form of genus-differentia definitions:
 
−
 
 
−
B is an A that has X.
 
−
 
 
−
The term (B) is defined by its membership in higher category (A) and distinguished by characteristics (X). The following are examples of genus-differentia definitions in the TAO:
 
−
 
 
−
1. The antorbital is a dermal bone that is located on the anterior margin of the infraorbital series, dorsal to the first infraorbital and lateral to the nasal bone.
 
−
 
 
−
2. The dentary is a dermal bone that forms the anterolateral part of the lower jaw.
 
−
 
 
−
In example 1, the definition mentions the parent dermal bone of the term antorbital followed by the characteristics that differentiate antorbital from all other dermal bones.
 
−
 
 
−
[http://wiki.geneontology.org/index.php/Logical_Definitions Logical definitions] (also known as cross-products) are constructed as the intersection between terms and are genus-differentia definitions.
 
−
 
 
−
===Proper syntax for relative length===
 
−
For the characters that relate the length of one bone to another, ratios are used in Phenote.  For example: Length of infraorbital 2: (0) over twice as long as infraorbital 1; (1) less than twice as long as infraorbital 1. This would be indicated in Phenote as follows:
 
−
 
 
−
E1: Infraorbital 2, Q: increased length, , E2 : Infraorbital 1, Measurement:  >2, Unit: ratio
 
−
 
 
−
E1: Infraorbital 2, Q: decreased length, , E2 : Infraorbital 1, Measurement:  <2, Unit: ratio
 
−
 
 
−
==Ontology change requests==
 
−
 
 
−
Here are links to ontology term trackers:
 
−
* [http://sourceforge.net/tracker/?group_id=76834&atid=994764 Teleost anatomy tracker]
 
−
* [http://sourceforge.net/tracker/?group_id=76834&atid=994726 Zebrafish anatomy tracker]
 
−
* [http://sourceforge.net/tracker/?atid=1046550&group_id=76834 Teleost taxonomy ontology tracker]
 
−
* [http://sourceforge.net/tracker/?group_id=76834&atid=595654 PATO tracker]
 

Latest revision as of 01:17, 26 March 2019

The following instructions outline the resources used by Phenoscape curators for the annotation of evolutionary phenotypes. If you are a student intern, please refer to the Student Instructions page for more information and links.

Data uploaded to the Phenoscape Knowledgebase are made available under a Creative Commons Attribution 3.0 Unported license (see Phenoscape data policy)

1. Download Most Recent Version of Phenex

Phenex was developed by Phenoscape for annotation of evolutionary phenotypes. You can find instructions for downloading and installing Phenex at the Phenex homepage.

2. Access Project Files

Phenoscape project files are XML files (more specifically, they are in NeXML format) created using Phenex and available on GitHub at https://github.com/phenoscape/phenoscape-data.

3. Access PDFs for Curation

Phenoscape maintains a collection of PDFs for curation. Please ask project personnel (Wasila or Paula) for access to the collection.

4. Use Ontologies to Annotate Characters

The primary activity of a curator is to annotate the free-text characters from systematic studies using ontologies. Instructions for this activity can be found in the Phenoscape Guide to Character Annotation.

5. Update Taxon Lists

Most project files require a taxonomic expert to review the taxonomy used in a publication and update to reflect current taxonomy. Please see instructions for creating taxon lists in Phenex or instructions for updating taxon lists with valid taxon names.

6. Request New Terms for Ontologies

Curation drives ontology development and many new terms and relationships need to be added. Submit requests for updates to the ontologies used in Phenoscape to the following term trackers:

7. Edit the Anatomy Ontology

8. Subscribe to Curator and Ontology Request Mailing Lists

  • Discussion of ontology development and Open Biomedical Ontologies community issues obo-discuss
Retrieved from "https://wiki.phenoscape.org/wg/phenoscape/index.php?title=Resources_for_Data_Contributors&oldid=12058"