annotate rp2biosensor.xml @ 1:b7713d32248b draft

"planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
author tduigou
date Fri, 25 Feb 2022 07:16:18 +0000
parents eaab33f23abf
children b0efd4b2ffba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
1 <tool id="rp2biosensor" name="rp2biosensor" version="@TOOL_VERSION@" profile="19.09">
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
2 <description>Build Sensing-Enabling Metabolic Pathways from RetroPath2.0 output</description>
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
3 <macros>
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
4 <token name="@TOOL_VERSION@">2.1.0</token>
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
5 </macros>
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
6 <requirements>
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
7 <requirement type="package" version="@TOOL_VERSION@">rp2biosensor</requirement>
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
8 </requirements>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
9 <command detect_errors="exit_code"><![CDATA[
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
10 python -m rp2biosensor
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
11 '$rp2_results'
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
12 --opath '$html_file'
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
13 #if str($adv.json_graph) == "true"
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
14 --ojson '$json_file'
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
15 #end if
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
16 ]]></command>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
17 <inputs>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
18 <param name="rp2_results" type="data" format="csv" label="RetroPath2 output"/>
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
19 <section name="adv" title="Advanced Options" expanded="false">
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
20 <param name="json_graph" type="boolean" label="Output Graph in JSON?" checked="false" />
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
21 </section>
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
22 </inputs>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
23 <outputs>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
24 <data name="html_file" format="html" label="${tool.name} - ${rp2_results.name}"/>
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
25 <data name="json_file" format="json" label="${tool.name} -${rp2_results.name}">
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
26 <filter> adv['json_graph'] </filter>
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
27 </data>
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
28 </outputs>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
29 <tests>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
30 <test>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
31 <!-- test 1: check if identical outputs are produced -->
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
32 <param name="rp2_results" value="rp2-results-lactate.csv" />
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
33 <output name="html_file" md5="88ba7cd2501c4d671b9eac396e7b4af9"/>
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
34 </test>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
35 </tests>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
36 <help><![CDATA[
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
37 rp2biosensor
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
38 ================
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
39
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
40 Generate HTML outputs to explore Sensing Enabling Metabolic Pathway from RetroPath2 results.
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
41
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
42 Input
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
43 -----
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
44
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
45 Required:
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
46
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
47 * **rp2_results**\ : (string) RetroPath2.0 results.
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
48
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
49 Output
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
50 ------
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
51
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
52 * **opath**\ : (string) Output path. Default: biosensor.html.
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
53
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
54 * **otype**\ : (string) Output type. This could be either (i) "dir" which means ouput files will outputted into this directory, or (ii) "file" which means that all files will be embedded into a single HTML page. Default: file.
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
55
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
56 * **ojson**\ : (string) Output the graph as json file if the path is not None. Default: None
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
57
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
58 Project Links
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
59 ------------------
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
60
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
61 * `GitHub <https://github.com/brsynth/rp2biosensor>`_
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
62
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
63 Version
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
64 ----------
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
65
1
b7713d32248b "planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty"
tduigou
parents: 0
diff changeset
66 2.1.0
0
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
67
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
68 Authors
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
69 -------
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
70
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
71 * **Thomas Duigou**
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
72
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
73 License
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
74 -------
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
75
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
76 * `MIT <https://github.com/brsynth/rp2biosensor/blob/master/LICENSE.md>`_
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
77
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
78 ]]></help>
eaab33f23abf "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
79 </tool>