annotate rpcompletion.xml @ 0:ae16d7ce27d1 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
author tduigou
date Tue, 28 Mar 2023 12:08:32 +0000
parents
children eeb447ee56e4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
1 <tool id="rptools_rpcompletion" name="Complete Reactions" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.09">
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
2 <description>Completes mono-component reactions output by RetroPath2.0 with the appropriate cofactors</description>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
3 <macros>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
4 <import>macros.xml</import>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
5 </macros>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
6 <expand macro="requirements"/>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
7 <stdio>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
8 <exit_code range="1" level="fatal" description="Could not Xref compartment_id" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
9 <exit_code range="2" level="fatal" description="ValueError returned" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
10 </stdio>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
12 python -m rptools.rpcompletion
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
13 '$rp2_pathways'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
14 '$sink'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
15 '$rp2paths_compounds'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
16 '$rp2paths_pathways'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
17 completed_pathways
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
18 --upper_flux_bound '$adv.upper_flux_bound'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
19 --lower_flux_bound '$adv.lower_flux_bound'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
20 --max_subpaths_filter '$adv.max_subpaths_filter'
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
21 --cache-dir "\${TMPDIR:-.}"
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
22 ]]></command>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
23 <inputs>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
24 <param name="rp2paths_pathways" type="data" format="csv" label="RP2paths pathways" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
25 <param name="rp2paths_compounds" type="data" format="tabular" label="RP2paths compounds" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
26 <param name="rp2_pathways" type="data" format="csv" label="RetroPath2.0 metabolic network" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
27 <param name="sink" type="data" format="csv" label="Sink from SBML" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
28 <section name="adv" title="Advanced Options" expanded="false">
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
29 <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." />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
30 <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." />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
31 <param argument="lower_flux_bound" type="integer" value="-10000" 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." />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
32 </section>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
33 </inputs>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
34 <outputs>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
35 <collection name="pathways" type="list" label="${tool.name}">
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
36 <discover_datasets pattern="(?P&lt;designation&gt;.+)\.xml" format="xml" directory="completed_pathways" visible="false" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
37 </collection>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
38 </outputs>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
39 <tests>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
40 <test>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
41 <!-- test 1: check if outputs are represented in an expected number -->
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
42 <param name="rp2paths_pathways" value="4-rp2paths_pathways.csv" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
43 <param name="rp2paths_compounds" value="3-rp2paths_compounds.tsv" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
44 <param name="rp2_pathways" value="1-rp2_metnet.csv" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
45 <param name="sink" value="2-sink.csv" />
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
46 <output_collection name="pathways" type="list" count="9"/>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
47 </test>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
48 </tests>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
49 <help><![CDATA[
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
50 rpCompletion
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
51 ============
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
52
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
53 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.
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
54
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
55 Input
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
56 -----
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
57
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
58 Required:
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
59
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
60 * **RetroPath2.0 metabolic network**: RetroPath2.0 pathways file
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
61 * **Sink from SBML**: rpextractsink file containing infos on molecules in the sink
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
62 * **RP2paths compounds**: rp2paths compounds file
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
63 * **RP2paths pathways**: rp2paths pathways file
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
64
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
65 Advanced options:
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
66
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
67 * **Upper flux bound**: (integer, default=9999) Upper flux bound value to be used in outputted SBML models (fbc SBML package) for new reactions created.
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
68 * **Lower flux bound**: (integer, default=0) Lower flux bound value to be used in outputted SBML models (fbc SBML package) for new reactions created.
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
69 * **Max subpaths generated per pathway**: (integer, default=10, 0=nofilter) Maximal number of subpaths to be created per master pathway.
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
70
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
71 Output
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
72 ------
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
73
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
74 * **pathways**: SBML completed pathways
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
75 ]]></help>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
76 <expand macro="creator"/>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
77 <citations>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
78 <citation type="doi">10.1038/s41467-022-32661-x</citation>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
79 </citations>
ae16d7ce27d1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/rptools commit 2333b7b56422febf439cd9f4cd3e6eda858b2690
tduigou
parents:
diff changeset
80 </tool>