Difference between revisions of "Resources for Data Contributors"

From phenoscape
(Installation and start up)
 
(141 intermediate revisions by 6 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 [[taxonomy ontology]] is not yet available, but it will be generated from the [http://www.calacademy.org/RESEARCH/ichthyology/catalog/fishcatsearch.html Catalog of Fishes].
+
==2. Access Project Files==
  
===On your desktop===
+
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.
  
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.
+
==3. Access PDFs for Curation ==
  
==Annotating phenotypes==
+
Phenoscape maintains a collection of PDFs for curation. Please ask project personnel (Wasila or Paula) for access to the collection.
  
===Phenote===
+
==4. Use Ontologies to Annotate Characters ==
  
[http://www.phenote.org/ Phenote] is used by ZFIN and FlyBase for mutant phenotype annotationWe are developing enhancements to the Phenote [[EQ Editor]] for PhenoScape data curation. Some of the PhenoScape-specific enhancements include:
+
The primary activity of a curator is to annotate the free-text characters from systematic studies using ontologiesInstructions for this activity can be found in the [[Guide to Character Annotation | '''Phenoscape Guide to Character Annotation''']].
  
* [[Phenote:Specimen List|A specimen list window]] allowing repeated annotation of the specimens within one publication.
+
==5. Update Taxon Lists==
* [[Phenote:Phylogeny Chooser|A phylogeny view]] allowing application of an EQ annotation to all specimens from a clade at once.
 
  
====Installation and start up====
+
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.
  
* You need Java 1.5 or newer to run Phenote.  For the Mac this requires Mac OS X 10.4 or newer.
+
==6. Request New Terms for Ontologies==
* 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/fishevolution/images/4/40/Phenote-MacOSX.zip Mac OS X] or [https://www.nescent.org/wg/fishevolution/images/d/db/Phenote-Windows.zip Windows].
 
* 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====
+
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:
  
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.
+
* [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]
  
{| border="1" cellspacing="0" cellpadding="3"
+
==7. Edit the Anatomy Ontology ==
! Field
+
* [http://phenoscape.org/wiki/Ontology_workflow Ontology Editing Guidelines]
! Usage
 
|-
 
| Publication || the publication describing the character state
 
|-
 
| 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].
+
==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]
  
==Ontology change requests==
+
[[Category:Curation]]
 
+
[[Category:Help]]
Here are links to ontology term trackers:
 
* [http://sourceforge.net/tracker/?group_id=76834&atid=595654 PATO tracker]
 
* Zebrafish anatomy - ''does anyone know if there is a term 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