|| '''RFC Name''' : Web Services - ID Mapping || '''Editor(s)''': Sarah, Ethan, Alex ||

<<TableOfContents([2])>>

== About this document ==

This is an official Request for Comment (RFC) for '''Add your text here'''.

For details on RFCs in general, check out the [[http://www.answers.com/main/ntquery?method=4&dsid=2222&dekey=Request+for+Comments&gwp=8&curtab=2222_1&linktext=Request%20for%20Comments|Wikipedia Entry:  Request for Comments (RFCs)]]

== Status ==

April 13, 2007

See [DataIntegration: RFC 39]
== Proposal ==

Enhance Cytoscape’s data connectivity by putting together a basic API for a web service multiple groups implement as a test case for further development into web service/database connectivity for Cytoscape.

This case will deal with an id mapping/translation service.  

== Biological Questions / Use Cases ==

 * Biologists often need to translate one id to another to connect various pieces of data. 
 * The mappings are available, but not easily accessible in Cytoscape currently.
 * Additional Use cases from [[http://baderlab.org/IdentifierMapping|Bader Lab ID Mapping page]]: 
  1. Unification during dataset merging: During a merge operation e.g. of two protein-protein interaction datasets from independently created databases, it is vital to recognize that two protein objects, one from each data source, represent the same protein molecule, even if the protein objects don’t share any database accession numbers. Unification requires knowledge of record type e.g. you cannot reliably use a gene ID to unify proteins (mostly because splice variants exist).
  1. Link out to related references: When presenting information about a protein to a user on a web page, it is useful to display links to related information about the protein, such as further information about the protein sequence and sequence feature annotations (e.g. in UniProt), Gene Ontology annotations, domains  annotations (InterPro), etc.
  1. Identifier translation: Some analysis methods require specific translations from one set of identifiers to another. For instance, our ‘activity centers’ analysis requires translation from protein or gene identifiers in a pathway database to Affymetrix probe set identifiers or other gene expression array platform  identifiers.
  1. Searching for a favorite gene name: Preferred gene names used for querying a pathway database should return all genes/proteins with that name, if they exist in the database. Unlike database accession numbers, gene names are not guaranteed unique, thus cannot reliably be used for the other use cases.
  1. Special case of identifier translation between species via orthology links.

== General Notes ==

== Requirements ==

== Deferred Items ==

== Open Issues ==

== Backward Compatibility ==

== Expected growth and plan for growth ==

== References ==

ISB’s Current ID Service:
 * [[attachment:ISB_SynonymService.doc]] - description of service/methods
 * [[attachment:ISB_Mammalian_WSDL.xml]] - example wsdl from our mammalian service

Note that while it is implemented in SOAP, we get REST along with it.  Any of the described methods can be called.

ISB prototype UDDI/id mapping plugin.  Our endpoints are behind a firewall, but at least it's some example type code (very alpha)
 * [[attachment:WS_IdMapping.zip]]  -  warning 7.2mb
 * Screenshot of ISB browser plugin: 
{{attachment:ISB_uddibrowser.png}}
 * Screenshot of the id mapper, this takes all selected nodes translates from one alias to another:
{{attachment:ISB_idmapper2.png}}
 * GenMAPP prototype of a GeneFinder plugin to connect nodes to database objects (works with embedded Derby databases):
{{attachment:GeneFinder.png}}

Services to look at for reference points:
 * [[http://biomoby.org|BioMoby]] (Registry/discovery tool)
   - Doesn't appear that there has been an update/release since April of 2006 and no way to contact them for information - sk
 * [[http://discover.nci.nih.gov/matchminer/command.jsp|NCI MatchMiner]] (id mapping, do they have a web service interface?)
   - Contacted MM, there is no web service and no plans to add one soon - sk
 * [[https://cabig.nci.nih.gov/tools/GeneConnect|GeneConnect]] - caBIG's id mapping service
 * [[http://vortex.cs.wayne.edu/projects.htm#Onto-Translate|Onto-Translate]] (id mapping, do they have a web service interface?)

Bader Lab's ID Mapping Use Cases and References
 * http://baderlab.org/IdentifierMapping

== Implementation Plan ==

 1. Alex & Sarah will work together towards a common web service api for id mapping
 2. Implement a discovery/use plugin prototype

== Comments ==