annotate retropath2_wrapper.xml @ 12:ee9cdd04052e draft default tip

planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 1e01b679611d980f87089184e7d8a538b96d68c7
author tduigou
date Tue, 30 May 2023 21:07:50 +0000
parents 805988211e6c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
805988211e6c planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit eadd9bb9edbc70361b9e8d7900e6743b37142ee3
tduigou
parents: 10
diff changeset
1 <tool id="retropath2" name="RetroPath2.0" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.09" license="MIT">
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
2 <description>Build a reaction network from a set of source compounds to a set of sink compounds</description>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
3 <macros>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
4 <token name="@VERSION_SUFFIX@">0</token>
10
db0138e42c19 planemo upload commit be50878b7e90467860bbe85aac55ea8e3507d1e5
tduigou
parents: 9
diff changeset
5 <token name="@TOOL_VERSION@">3.0.1</token>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
6 </macros>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
7 <requirements>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">retropath2_wrapper</requirement>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
9 </requirements>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
10 <stdio>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
11 <exit_code range="1" level="fatal" description="Cannot find source-in-sink file" />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
12 <exit_code range="2" level="fatal" description="Running the RetroPath2.0 Knime program produced an OSError" />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
13 <exit_code range="3" level="fatal" description="The InChI string is malformed" />
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
14 <exit_code range="-1" level="warning" description="Source has been found in the sink" />
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
15 <exit_code range="-2" level="warning" description="RetroPath2.0 has found no solution" />
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
16 <exit_code range="-3" level="warning" description="Time limit reached" />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
17 </stdio>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
18 <command detect_errors="exit_code"><![CDATA[
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
19 python -m retropath2_wrapper
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
20 '$sinkfile'
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
21 '$rulesfile'
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
22 out
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
23 --source_inchi '$source_inchi'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
24 --source_name '$source_name'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
25 --rp2_version '$adv.version'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
26 --max_steps '$max_steps'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
27 --topx '$adv.topx'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
28 --dmin '$adv.dmin'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
29 --dmax '$adv.dmax'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
30 --mwmax_source '$adv.mwmax_source'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
31 --kinstall "\${TMPDIR:-.}"
9
23d2987132ab planemo upload commit 13c2d871e134331cf1a70a638bd97eea82322935-dirty
tduigou
parents: 8
diff changeset
32 --msc_timeout '$adv.timeout' &&
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
33 if compgen -G 'out/*_scope.csv' > /dev/null; then
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
34 cp out/*_scope.csv '$Reaction_Network';
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
35 else
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
36 cp out/results.csv '$Reaction_Network';
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
37 fi
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
38 ]]></command>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
39 <inputs>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
40 <param name="rulesfile" type="data" format="csv,tar" label="Rules File" help="File containing reaction rules which reflect the enzymatic potential of the chassis organism."/>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
41 <param name="sinkfile" type="data" format="csv" label="Sink File" help=" Sink file which comprises all compounds that are considered as granted in your system."/>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
42 <param name="source_inchi" type="text" label="Source InChI" optional="false" help="InChI of compound to produce.">
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
43 <validator type="empty_field" message="You must provide the InChI string"/>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
44 </param>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
45 <param name="max_steps" type="integer" value="3" min="1" max="10" label="Maximal Pathway length" help="The maximal number of metabolic steps (i.e. reactions) for exploring around the target."/>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
46 <param name="source_name" type="text" value="target" optional="true" label="Source name" help="Name of compound to produce.">
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
47 <validator type="empty_field" message="Source name is required."/>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
48 </param>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
49 <section name="adv" title="Advanced Options" expanded="false">
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
50 <param name="version" type="select" label="Workflow version" help="Retropath2.0 Workflow versions, formatted as 'r{year}{month}{day}' (the latest version 'r20220104' is used by default).">
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
51 <option value="v9">v9</option>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
52 <option value="r20210127">r20210127</option>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
53 <option value="r20220104" selected="true">r20220104</option>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
54 </param>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
55 <param name="topx" type="integer" value="100" min="1" max="1000" label="TopX" help="The maximal number of intermediate compounds to use as new starting points for a next iteration of the retrosynthesis algorithm." />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
56 <param name="dmin" type="integer" value="0" min="0" max="1000" label="Minimum rule diameter" help="Minimum rule diameter of the sphere including the atoms around the reacting center. The higher is the diameter, the more specific are the rules." />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
57 <param name="dmax" type="integer" value="1000" min="0" max="1000" label="Maximum rule diameter" help="Maximum rule diameter of the sphere including the atoms around the reacting center. The higher is the diameter, the more specific are the rules."/>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
58 <param name="mwmax_source" type="integer" value="1000" min="0" max="2000" label="Molecular weight of source (Da)" help="The molecular weight cutoff (in Da), above which initial source (ie target) and intermediate compounds will be filtered out." />
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
59 <param name="timeout" type="integer" value="60" min="30" max="600" label="Timeout (min)" help="Maximal time of RetroPath2.0 execution (60 minutes by default)." />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
60 </section>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
61 </inputs>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
62 <outputs>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
63 <data name="Reaction_Network" format="csv" label="${tool.name}" >
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
64 <actions>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
65 <action name="column_names" type="metadata" default="Initial source,Transformation ID,Reaction SMILES,Substrate SMILES,Substrate InChI,Product SMILES,Product InChI,In Sink,Sink name,Diameter,Rule ID,EC number,Score,Starting Source SMILES,Iteration" />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
66 </actions>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
67 </data>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
68 </outputs>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
69 <tests>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
70 <test>
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
71 <!-- test 1: check if identical outputs are produced with default parameters -->
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
72 <param name="rulesfile" value="rules.csv" />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
73 <param name="sinkfile" value="sink.csv" />
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
74 <param name="source_inchi" value="InChI=1S/C40H56/c1-33(2)19-13-23-37(7)27-17-31-39(9)29-15-25-35(5)21-11-12-22-36(6)26-16-30-40(10)32-18-28-38(8)24-14-20-34(3)4/h11-12,15-22,25-32H,13-14,23-24H2,1-10H3/b12-11+,25-15+,26-16+,31-17+,32-18+,35-21+,36-22+,37-27+,38-28+,39-29+,40-30+" />
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
75 <output name="Reaction_Network" file="results_retropath2.csv" ftype="csv" compare="diff"/>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
76 </test>
10
db0138e42c19 planemo upload commit be50878b7e90467860bbe85aac55ea8e3507d1e5
tduigou
parents: 9
diff changeset
77 </tests>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
78 <help><![CDATA[
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
79 Retropath2.0 wrapper
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
80 ====================
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
81
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
82
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
83 Perform retrosynthesis search of possible metabolic routes between a source molecule and a collection of sink molecules. This tool is an implementation of the `KNIME retropath2.0 workflow <https://www.myexperiment.org/workflows/4987.html>`_. It takes for input the minimal (dmin) and maximal (dmax) diameter for the reaction rules and the maximal path length (maxSteps). The tool expects the following files: rules.csv, sink.csv and source.csv and produce a retrosynthesis network as a CSV file providing reactions in the reaction SMILES format and chemicals in both SMILES and InChI formats along with other information like the score for each reaction. Only a single source molecule is processed at this time.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
84
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
85 Input
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
86 -----
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
87
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
88 Required:
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
89
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
90 * **Sink File**\ : (string) Sink file which comprises all compounds that are considered as granted in your system.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
91 * **Source InChI**\ : (string) InChI of compound to produce.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
92 * **Source name**\ : (string) Name of compound to produce.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
93 * **Maximal Pathway length**\ : (integer) The maximal number of metabolic steps (i.e. reactions) for exploring around the target.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
94 * **Rules File**\ : (string) File containing reaction rules which reflect the enzymatic potential of the chassis organism.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
95
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
96
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
97 Advanced options:
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
98
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
99 * **TopX**\ : (integer, default: 100) The maximal number of intermediate compounds to use as new starting points for a next iteration of the retrosynthesis algorithm.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
100 * **Minimum rule diameter**\ : (integer, default: 0) Minimum rule diameter of the sphere including the atoms around the reacting center. The higher is the diameter, the more specific are the rules.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
101 * **Maximum rule diameter**\ : (integer, default: 1000) Maximum rule diameter of the sphere including the atoms around the reacting center. The higher is the diameter, the more specific are the rules.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
102 * **Molecular weight of source (Da)**\ : (integer, default: 1000) The molecular weight cutoff (in Da), above which initial source (ie target) and intermediate compounds will be filtered out.
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
103 * **Timeout (min)**\ : (integer, default: 60) Maximal time of RetroPath2.0 execution (60 minutes by default)
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
104 * **Workflow version**\ : Retropath2.0 Workflow versions, formatted as r{year}{month}{day} (the latest version r20220104 is used by default)
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
105
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
106 Output
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
107 ------
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
108
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
109 * **Reaction Network**\ : CSV file containing retrosynthesis network which provides reactions in the reaction SMILES format and chemicals in both SMILES and InChI formats along with other information like the score for each reaction.
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
110 ]]></help>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
111 <citations>
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
112 <citation type="doi">10.1016/j.ymben.2017.12.002 </citation>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
113 </citations>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
114 </tool>