annotate rpcompletion.xml @ 5:37bed74bbd44 draft default tip

planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
author tduigou
date Fri, 18 Nov 2022 16:07:59 +0000
parents e8d56cb2be03
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
1 <tool id="rpcompletion" name="Complete Reactions" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.09">
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
2 <description>Completes mono-component reactions output by RetroPath2.0 with the appropriate cofactors</description>
1
b8242cf18cc0 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
3 <macros>
5
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
4 <token name="@VERSION_SUFFIX@">0</token>
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
5 <token name="@TOOL_VERSION@">6.0.1</token>
1
b8242cf18cc0 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
6 </macros>
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
7 <requirements>
1
b8242cf18cc0 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 0
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">rptools</requirement>
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
9 </requirements>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
10 <stdio>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
11 <exit_code range="1" level="fatal" description="Could not Xref compartment_id" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
12 <exit_code range="2" level="fatal" description="ValueError returned" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
13 </stdio>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
14 <command detect_errors="exit_code"><![CDATA[
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
15 python -m rptools.rpcompletion
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
16 '$rp2_pathways'
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
17 '$sink'
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
18 '$rp2paths_compounds'
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
19 '$rp2paths_pathways'
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
20 completed_pathways
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
21 --upper_flux_bound '$adv.upper_flux_bound'
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
22 --lower_flux_bound '$adv.lower_flux_bound'
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
23 --max_subpaths_filter '$adv.max_subpaths_filter'
5
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
24 --cache-dir "\${TMPDIR:-.}"
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
25 ]]></command>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
26 <inputs>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
27 <param name="rp2paths_pathways" type="data" format="csv" label="RP2paths pathways" />
5
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
28 <param name="rp2paths_compounds" type="data" format="tabular" label="RP2paths compounds" />
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
29 <param name="rp2_pathways" type="data" format="csv" label="RetroPath2.0 metabolic network" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
30 <param name="sink" type="data" format="csv" label="Sink from SBML" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
31 <section name="adv" title="Advanced Options" expanded="false">
4
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
32 <param argument="max_subpaths_filter" type="integer" value="10" min="1" max="1000" label="Max subpaths generated per pathway" help="Maximal number of subpaths to be created per master pathway." />
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
33 <param argument="upper_flux_bound" type="integer" value="10000" min="-10000" max="10000" label="Upper flux bound" help="Upper flux bound value to be used in outputted SBML models (fbc SBML package) for new reactions created." />
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
34 <param argument="lower_flux_bound" type="integer" value="0" min="-10000" max="10000" label="Lower flux bound" help="Lower flux bound value to be used in outputted SBML models (fbc SBML package) for new reactions created." />
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
35 </section>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
36 </inputs>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
37 <outputs>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
38 <collection name="pathways" type="list" label="${tool.name}">
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
39 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.xml" format="xml" directory="completed_pathways" visible="false" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
40 </collection>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
41 </outputs>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
42 <tests>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
43 <test>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
44 <!-- test 1: check if identical outputs are produced with default parameters -->
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
45 <param name="rp2paths_pathways" value="4-rp2paths_pathways.csv" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
46 <param name="rp2paths_compounds" value="3-rp2paths_compounds.tsv" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
47 <param name="rp2_pathways" value="1-rp2_metnet.csv" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
48 <param name="sink" value="2-sink.csv" />
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
49 <output_collection name="pathways" type="list">
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
50 <element name="rp_001_0001" ftype="xml" file="rp_001_0001.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
51 <element name="rp_001_0006" ftype="xml" file="rp_001_0006.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
52 <element name="rp_001_0011" ftype="xml" file="rp_001_0011.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
53 <element name="rp_002_0001" ftype="xml" file="rp_002_0001.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
54 <element name="rp_002_0011" ftype="xml" file="rp_002_0011.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
55 <element name="rp_002_0021" ftype="xml" file="rp_002_0021.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
56 <element name="rp_003_0001" ftype="xml" file="rp_003_0001.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
57 <element name="rp_003_0131" ftype="xml" file="rp_003_0131.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
58 <element name="rp_003_0261" ftype="xml" file="rp_003_0261.xml" sort="true"/>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
59 </output_collection>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
60 </test>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
61 </tests>
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
62 <help><![CDATA[
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
63 rpCompletion
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
64 ============
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
65
4
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
66 Completes mono-component reactions output by `RetroPath2.0 <https://www.sciencedirect.com/science/article/pii/S1096717617301337>`_ with the appropriate cofactors. Creates sub-paths when multiple reaction rules are associated with a single reaction. Input is a single pathways file produced by RP2Paths. It stands on rpCache which store pre-computed data.
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
67
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
68 Input
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
69 -----
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
70
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
71 Required:
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
72
4
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
73 * **RetroPath2.0 metabolic network**: RetroPath2.0 pathways file
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
74 * **Sink from SBML**: rpextractsink file containing infos on molecules in the sink
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
75 * **RP2paths compounds**: rp2paths compounds file
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
76 * **RP2paths pathways**: rp2paths pathways file
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
77
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
78 Advanced options:
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
79
4
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
80 * **Upper flux bound**: (integer, default=9999) Upper flux bound value to be used in outputted SBML models (fbc SBML package) for new reactions created.
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
81 * **Lower flux bound**: (integer, default=0) Lower flux bound value to be used in outputted SBML models (fbc SBML package) for new reactions created.
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
82 * **Max subpaths generated per pathway**: (integer, default=10, 0=nofilter) Maximal number of subpaths to be created per master pathway.
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
83
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
84 Output
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
85 ------
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
86
e8d56cb2be03 planemo upload commit f40274f6b9f6a15eb4022aab21286d4c96cd8475-dirty
tduigou
parents: 3
diff changeset
87 * **pathways**: SBML completed pathways
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
88
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
89 Project Links
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
90 ---------------------
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
91 * `GitHub <https://github.com/brsynth/rptools>`_
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
92
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
93 Acknowledgments
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
94 ---------------
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
95
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
96 * Thomas Duigou
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
97
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
98 Licence
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
99 -------
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
100
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
101 `MIT <https://github.com/brsynth/rptools/blob/master/LICENSE>`_
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
102
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
103 ]]></help>
5
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
104 <creator>
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
105 <person givenName="Joan" familyName="Hérisson" email="joan.herisson@univ-evry.fr" identifier="https://orcid.org/0000-0001-9741-0847" />
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
106 <person givenName="Melchior" familyName="du Lac" identifier="https://orcid.org/0000-0002-9984-4689" />
37bed74bbd44 planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 4
diff changeset
107 </creator>
0
98d925a75257 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
108 </tool>