annotate retropath2_wrapper.xml @ 13:f26e7e4a42b7 draft

planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
author tduigou
date Wed, 08 Oct 2025 11:10:57 +0000
parents 805988211e6c
children 1edb49dfa335
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
1 <tool id="retropath2" name="RetroPath2.0" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
2 profile="21.09" license="MIT">
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
3 <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
4 <macros>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
6 <token name="@TOOL_VERSION@">3.5.0</token>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
7 </macros>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
8 <requirements>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
9 <requirement type="package" version="@TOOL_VERSION@">retropath2_wrapper</requirement>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
10 </requirements>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
11 <stdio>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
12 <!-- Fatal -->
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
13 <exit_code range="1" level="fatal" description="Cannot find source-in-sink file" />
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
14 <regex match="It seems that the target product is already in the chassis" source="both"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
15 level="fatal" description="It seems that the target product is already in the chassis" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
16 <exit_code range="2" level="fatal"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
17 description="Running the RetroPath2.0 Knime program produced an OSError" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
18 <regex match="The following error occured" source="both" level="fatal"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
19 description="The following error occured" />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
20 <exit_code range="3" level="fatal" description="The InChI string is malformed" />
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
21 <regex match="is not a valid InChI notation" source="both" level="fatal"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
22 description="is not a valid InChI notation" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
23 <exit_code range="4" level="fatal" description="Sink file is malformed" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
24 <regex match="The sink file is malformed" source="both" level="fatal"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
25 description="The sink file is malformed" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
26 <exit_code range="5" level="fatal" description="Knime installation error" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
27 <!-- Warning -->
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
28 <exit_code range="10" level="warning" description="Source has been found in the sink" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
29 <regex match="Source has been found in the sink" source="both" level="warning"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
30 description="Source has been found in the sink" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
31 <exit_code range="11" level="warning" description="RetroPath2.0 has found no solution" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
32 <regex match="No solution has been found" source="both" level="warning"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
33 description="No solution has been found" />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
34 </stdio>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
35 <command detect_errors="exit_code"><![CDATA[
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
36 #if $sink.emptysink:
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
37 echo '"Name","InChI"' > empty_sink.csv &&
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
38 #set $sinkfile = "empty_sink.csv"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
39 #end if
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
40 python -m retropath2_wrapper
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
41 '$sinkfile'
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
42 '$rulesfile'
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
43 out
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
44 --source_inchi '$source_inchi'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
45 --source_name '$source_name'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
46 --rp2_version '$adv.version'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
47 --max_steps '$max_steps'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
48 --topx '$adv.topx'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
49 --dmin '$adv.dmin'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
50 --dmax '$adv.dmax'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
51 --mwmax_source '$adv.mwmax_source'
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
52 --kinstall "\${TMPDIR:-.}"
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
53 --std_hydrogen '$adv.std_hydrogen'
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
54 #if not $sink.error_codes:
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
55 --quiet
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
56 #end if
9
23d2987132ab planemo upload commit 13c2d871e134331cf1a70a638bd97eea82322935-dirty
tduigou
parents: 8
diff changeset
57 --msc_timeout '$adv.timeout' &&
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
58 if compgen -G 'out/*_scope.csv' > /dev/null; then
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
59 cp out/*_scope.csv '$Reaction_Network';
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
60 else
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
61 cp out/results.csv '$Reaction_Network';
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
62 fi
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
63 ]]></command>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
64 <inputs>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
65 <param name="rulesfile" type="data" format="csv,tar" label="Rules File"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
66 help="File containing reaction rules which reflect the enzymatic potential of the chassis organism." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
67 <conditional name="sink">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
68 <param name="emptysink" type="boolean" checked="false" label="Empty sink" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
69 <when value="false">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
70 <param name="sinkfile" type="data" format="csv" label="Sink File"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
71 help="Sink file which comprises all compounds that are considered as granted in your system." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
72 <param name="error_codes" type="boolean" checked="true" label="Return error codes" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
73 </when>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
74 <when value="true">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
75 <param name="error_codes" type="boolean" checked="false" label="Return error codes" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
76 </when>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
77 </conditional>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
78 <param name="source_inchi" type="text" label="Source InChI" optional="false"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
79 help="InChI of compound to produce.">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
80 <validator type="empty_field" message="You must provide the InChI string" />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
81 </param>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
82 <param name="max_steps" type="integer" value="3" min="1" max="10"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
83 label="Maximal Pathway length"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
84 help="The maximal number of metabolic steps (i.e. reactions) for exploring around the target." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
85 <param name="source_name" type="text" value="target" optional="true" label="Source name"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
86 help="Name of compound to produce.">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
87 <validator type="empty_field" message="Source name is required." />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
88 </param>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
89 <section name="adv" title="Advanced Options" expanded="false">
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
90 <param name="version" type="select" label="Workflow version"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
91 help="Retropath2.0 Workflow versions, formatted as 'r{year}{month}{day}' (the latest version 'r20220104' is used by default).">
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
92 <option value="v9">v9</option>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
93 <option value="r20210127">r20210127</option>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
94 <option value="r20220104">r20220104</option>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
95 <option value="r20220224">r20220224</option>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
96 <option value="r20250728" selected="true">r20250728</option>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
97 </param>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
98 <param name="topx" type="integer" value="100" min="1" max="1000" label="TopX"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
99 help="The maximal number of intermediate compounds to use as new starting points for a next iteration of the retrosynthesis algorithm." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
100 <param name="dmin" type="integer" value="0" min="0" max="1000"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
101 label="Minimum rule diameter"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
102 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." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
103 <param name="dmax" type="integer" value="1000" min="0" max="1000"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
104 label="Maximum rule diameter"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
105 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." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
106 <param name="mwmax_source" type="integer" value="1000" min="0" max="2000"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
107 label="Molecular weight of source (Da)"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
108 help="The molecular weight cutoff (in Da), above which initial source (ie target) and intermediate compounds will be filtered out." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
109 <param name="timeout" type="integer" value="60" min="30" max="600" label="Timeout (min)"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
110 help="Maximal time of RetroPath2.0 execution (60 minutes by default)." />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
111 <param name="std_hydrogen" type="select" label="Hygrogens in chemical rules"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
112 help="How hydrogens are represented in chemical rules, auto mode will try to guess from the chemical rules">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
113 <option value="auto" selected="true">auto</option>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
114 <option value="implicit">Aromatized (no Hs added)</option>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
115 <option value="explicit">H added + Aromatized</option>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
116 </param>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
117 </section>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
118 </inputs>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
119 <outputs>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
120 <data name="Reaction_Network" format="csv" label="${tool.name}">
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
121 <actions>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
122 <action name="column_names" type="metadata"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
123 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" />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
124 </actions>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
125 </data>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
126 </outputs>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
127 <tests>
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
128 <test>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
129 <!-- test 1: check if identical outputs are produced with default parameters -->
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
130 <param name="rulesfile" value="rules.csv" />
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
131 <conditional name="sink">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
132 <param name="emptysink" value="false" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
133 <param name="sinkfile" value="sink.csv" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
134 </conditional>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
135 <param name="source_inchi"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
136 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+" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
137 <output name="Reaction_Network" file="results_retropath2.csv" ftype="csv" compare="diff" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
138 </test>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
139 <test>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
140 <!-- test 2: check empty sink file -->
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
141 <param name="rulesfile" value="rules.csv" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
142 <conditional name="sink">
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
143 <param name="emptysink" value="true" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
144 </conditional>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
145 <param name="source_inchi"
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
146 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+" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
147 <output name="Reaction_Network" file="results_emptysink.csv" ftype="csv" compare="diff" />
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
148 </test>
10
db0138e42c19 planemo upload commit be50878b7e90467860bbe85aac55ea8e3507d1e5
tduigou
parents: 9
diff changeset
149 </tests>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
150 <help><![CDATA[
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
151 Retropath2.0 wrapper
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
152 ====================
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
153
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
154 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
155
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
156 Output
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
157 ------
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
158
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
159 * **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
160 ]]></help>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
161 <creator>
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
162 <organization name="BioRetroSynth" url="https://github.com/brsynth" />
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
163 </creator>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
164 <citations>
8
91523c7ab46a planemo upload commit c59e296a2bf974bbea9c5a30b940e7ca3b68ff3e
tduigou
parents: 7
diff changeset
165 <citation type="doi">10.1016/j.ymben.2017.12.002 </citation>
7
c31a74a5595c planemo upload commit 7b62e9fb3271d06909bfad1918fcffc9255562cd
tduigou
parents:
diff changeset
166 </citations>
13
f26e7e4a42b7 planemo upload for repository https://github.com/brsynth/retropath2_wrapper commit 4f228a8dcee36f8c5282ff3e30f67a87254a2837-dirty
tduigou
parents: 11
diff changeset
167 </tool>