Cytoscape Wiki|
Size: 2664
Comment:
|
Size: 4198
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 8: | Line 8: |
| || '''RFC Name''' : BioWebServiceConnectivity || '''Editor(s)''': KeiichiroOno || '''Status''': Planning || | || '''RFC Name''' : BioWebServiceConnectivity || '''Editor(s)''': KeiichiroOno || '''Status''': Open for Comment || |
| Line 13: | Line 13: |
| These days, there are several public biological database web wervices such as Biomart, NCBI, or KEGG. It is very useful for many users if Cytoscape have an access to those huge data resources through simple user interface. By using this function, users can access virtually all kinds of annotations for the nodes, including variety of ID's, sequences, descriptions, orthologs, pathway names which contains the nodes, etc. Also, this is a general solution for all typs of node ID mapping problems Cytoscape currently have. |
These days, there are several public biological database web wervices such as Biomart, NCBI, or KEGG. It is very useful for many users if Cytoscape have an access to those huge data resources through simple user interface. By using this function, users can access virtually all kinds of annotations for the nodes, including variety of ID's, sequences, descriptions, orthologs, pathway names which contains the nodes, etc. Also, this is a general solution for all types of node ID mapping problems Cytoscape currently have. In addition, users can access network database web services thirough the same mechanism. The goal of this project is the following: * Implement a mechanism to manage web service clients in the Cytoscape core. * Design an interface which wraps each web service client. * Design mechanism how web service clients communicate with the core (Event handling). * Implement an simple UI for importing annotations and networks from the web services. |
| Line 19: | Line 24: |
| * ''I need to add sequence data to each nodes in my network.'' |
* ''I need to check the orthologs for the genes in my network.'' * ''I want to expand existing network with known interaction data in [http://www.ebi.ac.uk/intact/site/index.jsf IntAct]'' * Mapping known pathways onto network data in Cytoscape. * Executing an analysis program running on remote server which is implemented as a web service. |
| Line 22: | Line 30: |
| Each web service is a building block to make higher-level functions. This means plugin writers should be able to use registered web services as if they are local Java APIs. To achive this, we should be careful to separate UI from the core web service clients. | |
| Line 24: | Line 33: |
|
This component consists of 3 parts: 1. Core web service connectivity module 1. Core mapping module - Mapping fetched annotations onto !CyAttributes. 1. Support module for individual web services |
This component consists of 5 parts: 1. Web Service Client Manager in the core - Maintaining list of web service clients. - Each web service client implements an interface !WebServiceClient 1. Attribute mapping module - Mapping fetched annotations onto !CyAttributes. 1. Event Handlers - Implementing custom event and its listeners only for !WebServiceClients 1. Web Service Clients - these are jar files which contains properties and classes created from WSDL. They will be loaded as normal cytoscape plugins. |
| Line 29: | Line 41: |
|
By keeping these as modular as possible, we can easily add new UI for other web services. |
|
| Line 35: | Line 45: |
| * Taxonomy of the services | |
| Line 41: | Line 52: |
|
* [http://taverna.sourceforge.net/index.php?doc=services.html Biological Web Services] by myGrid/Taverna Project |
|
| Line 44: | Line 57: |
| ##If you want to create a separate subpage for the Implementation Plan, then provide this link: ["/Implementation Plan"] | |
| Line 52: | Line 64: |
|
SarahKillcoyne August 16, 2007 This RFC would seem to be very related to the [:DataIntegration: Data Integration] one. Might be useful to discuss this as part of a larger web services integration if we decide a larger, more general solution would be useful. |
RFC Name : BioWebServiceConnectivity |
Editor(s): KeiichiroOno |
Status: Open for Comment |
Proposal
These days, there are several public biological database web wervices such as Biomart, NCBI, or KEGG. It is very useful for many users if Cytoscape have an access to those huge data resources through simple user interface. By using this function, users can access virtually all kinds of annotations for the nodes, including variety of ID's, sequences, descriptions, orthologs, pathway names which contains the nodes, etc. Also, this is a general solution for all types of node ID mapping problems Cytoscape currently have. In addition, users can access network database web services thirough the same mechanism. The goal of this project is the following:
- Implement a mechanism to manage web service clients in the Cytoscape core.
- Design an interface which wraps each web service client.
- Design mechanism how web service clients communicate with the core (Event handling).
- Implement an simple UI for importing annotations and networks from the web services.
Biological Questions / Use Cases
User loaded network with EntrezGene ID as node identifier into Cytoscape. He/she needs to import annotation files with Gene Symbol as the key.
I need to check the orthologs for the genes in my network.
I want to expand existing network with known interaction data in [http://www.ebi.ac.uk/intact/site/index.jsf IntAct]
- Mapping known pathways onto network data in Cytoscape.
- Executing an analysis program running on remote server which is implemented as a web service.
General Notes
Each web service is a building block to make higher-level functions. This means plugin writers should be able to use registered web services as if they are local Java APIs. To achive this, we should be careful to separate UI from the core web service clients.
Requirements
This component consists of 5 parts:
- Web Service Client Manager in the core
- - Maintaining list of web service clients.
- Each web service client implements an interface WebServiceClient
- - Maintaining list of web service clients.
Attribute mapping module - Mapping fetched annotations onto CyAttributes.
Event Handlers - Implementing custom event and its listeners only for WebServiceClients
- Web Service Clients - these are jar files which contains properties and classes created from WSDL. They will be loaded as normal cytoscape plugins.
- GUI for each web services
Deferred Items
Open Issues
- Taxonomy of the services
Backward Compatibility
Expected growth and plan for growth
References
[http://taverna.sourceforge.net/index.php?doc=services.html Biological Web Services] by myGrid/Taverna Project
Implementation Plan
Comments
How to Comment
Edit the page and add your comments under the provided header. By adding your ideas to the Wiki directly, we can more easily organize everyone's ideas, and keep clear records. Be sure to include today's date and your name for each comment. Try to keep your comments as concrete and constructive as possible. For example, if you find a part of the RFC makes no sense, please say so, but don't stop there. Take the extra step and propose alternatives.
SarahKillcoyne August 16, 2007
This RFC would seem to be very related to the [:DataIntegration: Data Integration] one. Might be useful to discuss this as part of a larger web services integration if we decide a larger, more general solution would be useful.