annotate NCBO_services/extract.xml @ 26:354aa87772e0

Uploaded
author jose-minyarro
date Mon, 19 Mar 2012 08:25:59 -0400
parents 0078fe4c89e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
1 <tool id="extract" name="Extract a branch from an ontology" version="1.0.1">
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
2 <description>Retrieves a subtree from an ontology using a root concept</description>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
3 <command>java -jar ${__tool_data_path__}/shared/jars/extract.jar $api_key $ontologyversionid $conceptid $filterrelations $ontologyname > $output </command>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
4
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
5 <inputs>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
6 <param name="api_key" type="text" size="100" label="BioPortal API key" />
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
7 <param name="ontologyversionid" type="text" size="100" label="Ontology version ID" />
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
8 <param name="conceptid" type="text" size="100" label="Concept id" />
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
9 <param name="filterrelations" type="text" value="None" size="100" label="Filter relations" />
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
10 <param name="ontologyname" type="text" size="100" label="Ontology name" />
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
11 </inputs>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
12 <outputs>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
13 <data format="text" name="output" />
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
14 </outputs>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
15 <tests>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
16 <test>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
17 <param name="api_key"/>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
18 </test>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
19 </tests>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
20 <help>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
21
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
22 **What it does**
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
23
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
24 It extracts a subtree from an ontology contained in BioPortal, and retrieves such subtree as an OWL ontology.
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
25
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
26 **Parameters**
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
27
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
28 * Bioportal API key: to obtain an API key, open an account in http://bioportal.bioontology.org.
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
29 * Ontology version ID: it can be obtained from BioPortal, in the Ontology page, on the versions column, by looking at the version URL. For example, it is 46754 for the Gene Ontology.
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
30 * Concept ID: the root term. For example, GO:0051179.
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
31 * Filter relations: for example "is_a,part_of".
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
32 * Ontology name: the URI for the new ontology. For example http://go_redux_is_a.owl.
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
33
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
34 **Contact**
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
35
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
36 Please send any request or comment to mikel.egana.aranguren@gmail.com.
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
37
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
38 **More information**
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
39
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
40 http://bioportal.bioontology.org
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
41
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
42 http://www.bioontology.org/wiki/index.php/BioPortal_REST_services
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
43
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
44 </help>
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
45
0078fe4c89e3 get_ontology interface improved, extract tool added
Mikel Egaña Aranguren <mikel-egana-aranguren@toolshed.g2.bx.psu.edu>
parents:
diff changeset
46 </tool>