Help:WikiPathways Webservice

From WikiPathways

(Difference between revisions)
Jump to: navigation, search
(Showcase)
Line 4: Line 4:
= The WikiPathways web service =
= The WikiPathways web service =
WikiPathways can be accessed through a [[wikipedia:SOAP|SOAP]] webservice. This page contains documentation for the webservice API.
WikiPathways can be accessed through a [[wikipedia:SOAP|SOAP]] webservice. This page contains documentation for the webservice API.
 +
 +
== Showcase ==
 +
Click on one of the images below for examples on what you can do with the WikiPathways web service.
 +
 +
{|style="width:75%;" border="0" valign="top" cellspacing="5" cellpadding="1"
 +
|align="center"|<big>'''Search'''</big>{{#imgLink:WikiPathwaysSearch.png|150|center||Help|{{FULLPAGENAME}}/WikiPathwaysSearch|Search}}
 +
''Use the web service to search for pathways''
 +
|align="center"|<big>'''Integrate'''</big>{{#imgLink:AtlasMapper.png|150|center||Help|{{FULLPAGENAME}}/AtlasMapper|Integrate}}
 +
''Integrate pathway information with gene expression data''
 +
|-
 +
|align="center"|<big>'''Query interactions'''</big>{{#imgLink:Cytoscape.png|150|center||Help|{{FULLPAGENAME}}/Cytoscape|Cytoscape}}
 +
''Load pathways as interaction networks in Cytoscape''
 +
|align="center"|<big>'''Build workflows'''</big>{{#imgLink:Taverna.png|150|center||Help|{{FULLPAGENAME}}/Taverna|Taverna}}
 +
''Use pathway information in your Taverna workflows''
 +
|}
== Getting Started ==
== Getting Started ==
The web service is described in a WSDL file that can be downloaded from:
The web service is described in a WSDL file that can be downloaded from:
  [http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl]
  [http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl]
 +
 +
== API Reference ==
 +
See the [[{{FULLPAGENAME}}/API|API reference]] page for a list of available web service functions and data structures.
=== Java libraries for WikiPathways ===
=== Java libraries for WikiPathways ===
Line 78: Line 96:
}
}
</nowiki></pre>
</nowiki></pre>
-
 
-
== Showcase ==
 
-
Click on one of the images below for examples on what you can do with the WikiPathways web service.
 
-
 
-
{|style="width:75%;" border="0" valign="top" cellspacing="5" cellpadding="1"
 
-
|align="center"|<big>'''Search'''</big>{{#imgLink:WikiPathwaysSearch.png|150|center||Help|{{FULLPAGENAME}}/WikiPathwaysSearch|Search}}
 
-
''Use the web service to search for pathways''
 
-
|align="center"|<big>'''Integrate'''</big>{{#imgLink:AtlasMapper.png|150|center||Help|{{FULLPAGENAME}}/AtlasMapper|Integrate}}
 
-
''Integrate pathway information with gene expression data''
 
-
|-
 
-
|align="center"|<big>'''Query interactions'''</big>{{#imgLink:Cytoscape.png|150|center||Help|{{FULLPAGENAME}}/Cytoscape|Cytoscape}}
 
-
''Load pathways as interaction networks in Cytoscape''
 
-
|align="center"|<big>'''Build workflows'''</big>{{#imgLink:Taverna.png|150|center||Help|{{FULLPAGENAME}}/Taverna|Taverna}}
 
-
''Use pathway information in your Taverna workflows''
 
-
|}
 
-
 
-
=== Web applications ===
 
-
* [http://137.120.14.13:8180/wikipathways-search/WikiPathwaysSearch.html Searching WikiPathways]
 
-
* [http://137.120.14.13:8180/atlas-mapper/AtlasMapper.html Visualize gene expression information]
 
-
 
-
=== Workflows ===
 
-
You can use the WikiPathways webservice to integrate WikiPathways functions in your Taverna workflows. See [http://www.myexperiment.org/packs/30 myexperiment.org] for a set of example workflows that show how to call WikiPathways from Taverna.
 
-
 
-
=== Extending existing software ===
 
-
See the [http://www.pathvisio.org/Cytoscape_plugin Cytoscape plugin] for an example on how to use the web service to extend the functionality of existing software. You can install the plugin in your local Cytoscape installation from the [http://www.cytoscape.org/cgi-bin/moin.cgi/Cytoscape_User_Manual/Plugins plug-in manager].
 
-
 
-
=== Bots ===
 
-
 
-
== API Reference ==
 
-
See the [[{{FULLPAGENAME}}/API|API reference]] page for a list of available web service functions and data structures.
 
-
 
-----
-----
<p>[[:Help:Contents|Return to Help Contents]]</p>
<p>[[:Help:Contents|Return to Help Contents]]</p>
<p>[[:Help:Frequently_Asked_Questions|Continue to FAQ]]</p>
<p>[[:Help:Frequently_Asked_Questions|Continue to FAQ]]</p>

Revision as of 14:11, 12 December 2008

Contents

The WikiPathways web service

WikiPathways can be accessed through a SOAP webservice. This page contains documentation for the webservice API.

Showcase

Click on one of the images below for examples on what you can do with the WikiPathways web service.

Search

Use the web service to search for pathways

Integrate

Integrate pathway information with gene expression data

Query interactions

Load pathways as interaction networks in Cytoscape

Build workflows

Use pathway information in your Taverna workflows

Getting Started

The web service is described in a WSDL file that can be downloaded from:

http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl

API Reference

See the API reference page for a list of available web service functions and data structures.

Java libraries for WikiPathways

Coming soon

Working with GPML

The pathways on WikiPathways are stored in the GPML format. This is an XML format and can be processed in any programming language. See here for the GPML specification.

SOAP libraries

For most programming languages, libraries exist to make working with SOAP web service easier. Below is a short list of SOAP libraries for popular programming languages that might help you work with the WikiPathways web service.

Examples

Scripts

Coming soon: small example scripts in various languages.

R

Using the SSOAP package in R, you can retrieve pathway information from the WikiPathways web service and use it in your R scripts (e.g. for gene set enrichment or pathway statistics). Below are a few code snippets that show you how to use SSOAP with the WikiPathways web service.

## Install SSOAP from Bioconductor ##
source("http://bioconductor.org/biocLite.R")
biocLite("SSOAP")

## Load the SSOAP library ##
library(SSOAP)

## Create a SOAPServer instance for the web service ##
srv = SOAPServer("http://www.wikipathways.org/wpi/webservice/webservice.php");

## List all organisms on WikiPathways ##
reply = .SOAP(srv, "listOrganisms", action=I("listOrganisms"), handlers=NULL)
doc = xmlParse(reply$content, asText=TRUE)
organismNodes = xmlElementsByTagName(xmlRoot(doc), "organisms", TRUE)

for(node in organismNodes) {
	print(xmlValue(node)) #Print the organism name to the screen
}

## Find all pathways for the 'apoptosis' keyword ##
reply = .SOAP(srv, "findPathwaysByText", query="apoptosis", species="", action=I("findPathwaysByText"), handlers=NULL)
doc = xmlParse(reply$content, asText=TRUE)

# Find the result nodes with an xpath query
resultNodes = getNodeSet(doc, "//*[local-name()='result']")
# Print the pathway name, species and url for each result
for(node in resultNodes) {
	children = xmlChildren(node, addNames= TRUE)
	url = xmlValue(children$url)
	name = xmlValue(children$name);
	species = xmlValue(children$species);
	
	print(paste(name, " (", species, "): ", url, sep=""))
}

Return to Help Contents

Continue to FAQ

Personal tools