annotate rp2paths.xml @ 1:2c788cd11881 draft

"planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
author tduigou
date Thu, 02 Dec 2021 12:25:16 +0000
parents
children 550f1c02caba
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
1 <tool id="rp2paths" name="RP2paths" version="1.4.3">
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
2 <description>Enumerate and seperate the different pathways generated by RetroPath2.0</description>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
3 <requirements>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
4 <requirement type="package" version="1.4.3">rp2paths</requirement>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
5 </requirements>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
6 <stdio>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
7 <regex match="TIMEOUT:" level="fatal" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
8 <regex match="ERROR:" level="fatal" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
9 <regex match="WARNING:" level="warning" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
10 </stdio>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
11 <command detect_errors="exit_code"><![CDATA[
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
12 #from os import path as os_path
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
13 cd /tmp &&
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
14 #set outFolder = os_path.basename(str($master_pathways))
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
15 mkdir '$outFolder' &&
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
16 python -m rp2paths all
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
17 '$rp2_pathways'
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
18 --outdir '$outFolder'
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
19 --timeout '$adv.timeout' &&
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
20 cp '$outFolder'/compounds.txt '$compounds' &&
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
21 cp '$outFolder'/out_paths.csv '$master_pathways' &&
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
22 rm -rf $outFolder
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
23 ]]></command>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
24 <inputs>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
25 <param name="rp2_pathways" type="data" format="csv" label="RetroPath2.0 Pathways" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
26 <section name="adv" title="Advanced Options" expanded="false">
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
27 <param name="timeout" type="integer" value="1800" label="Time Out" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
28 </section>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
29 </inputs>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
30 <outputs>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
31 <data name="master_pathways" format="csv" label="${tool.name} (Pathways)" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
32 <data name="compounds" format="tsv" label="${tool.name} (Compounds)" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
33 </outputs>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
34 <tests>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
35 <test>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
36 <!-- test 1: check if identical outputs are produced with default parameters -->
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
37 <param name="rp2_pathways" value="retropath2_pathways.csv" />
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
38 <output name="master_pathways" file="rp2paths_pathways.csv" ftype="csv" compare="diff"/>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
39 <output name="compounds" file="rp2paths_compounds.tsv" ftype="tsv" compare="diff"/>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
40 </test>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
41 </tests>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
42 <help><![CDATA[
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
43 rp2paths
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
44 ========
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
45
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
46
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
47 RP2paths extracts the set of pathways that lies in a metabolic space file output by the RetroPath2.0 workflow. Source code may be found at the following location: `GitHub <https://github.com/brsynth/rp2paths>`_.
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
48
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
49 Input
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
50 -----
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
51
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
52 Required information:
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
53
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
54
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
55 * **rp_results**\ : (string) Path to the ReatroPath2.0 pathways file
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
56
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
57 Advanced options:
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
58
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
59
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
60 * **timeout**\ : (string, default: 30 minutes) Time out time of the tool
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
61 * **server_url**\ : (string) IP address of the rp2paths REST service
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
62
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
63 Output
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
64 ------
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
65
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
66
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
67 * **out_paths**\ : (string) Path to the RP2paths pathways. Describes all the indiviudal enumerated pathways that produce the compound of interest.
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
68 * **out_compounds**\ : (string) Path to the RP2paths Compounds. Describes the structure of all the chemical species involved in all pathways.
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
69
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
70 Versioning
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
71 ----------
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
72
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
73 v1.4.3
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
74
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
75 Authors
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
76 -------
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
77
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
78
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
79 * **Melchior du Lac**
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
80 * Thomas Duigou
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
81 * Baudoin Delépine
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
82 * Pablo Carbonell
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
83
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
84 License
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
85 -------
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
86
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
87 `MIT <https://github.com/brsynth/rp2paths/blob/master/LICENSE.md>`_
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
88
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
89 Acknowledgments
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
90 ---------------
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
91
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
92
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
93 * Joan Hérisson
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
94
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
95 ]]></help>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
96 <citations>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
97 <citation type="bibtex">
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
98 @article{delepine2018retropath2,
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
99 title={RetroPath2.0: a retrosynthesis workflow for metabolic engineers},
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
100 author={Del{\'e}pine, Baudoin and Duigou, Thomas and Carbonell, Pablo and Faulon, Jean-Loup},
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
101 journal={Metabolic engineering},
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
102 volume={45},
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
103 pages={158--170},
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
104 year={2018},
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
105 publisher={Elsevier}}
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
106 </citation>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
107 </citations>
2c788cd11881 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
108 </tool>