Mercurial > repos > tduigou > rpextractsink

annotate rpextractsink.xml @ 4:191665a689de draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
author tduigou
date Fri, 18 Nov 2022 16:11:40 +0000
parents 47bb93e7832b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
1 <tool id="rpextractsink" name="Sink from SBML" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.09">
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
2 <description>Generate the RetroPath2.0 sink file from an SBML input</description>
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
3 <macros>
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
4 <token name="@VERSION_SUFFIX@">0</token>
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
5 <token name="@TOOL_VERSION@">6.0.1</token>
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
6 </macros>
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
7 <requirements>
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
8 <requirement type="package" version="@TOOL_VERSION@">rptools</requirement>
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
9 </requirements>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
10 <stdio>
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
11 <regex match="Could not retreive any species in the compartment" level="fatal" />
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
12 </stdio>
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
13 <command detect_errors="exit_code"><![CDATA[
2
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
14 python -m rptools.rpextractsink
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
15 '$input'
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
16 '$sink'
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
17 --compartment_id '$compartment_id'
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
18 $adv.remove_dead_end
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
19 --cache-dir "\${TMPDIR:-.}"
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
20 ]]></command>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
21 <inputs>
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
22 <param name="input" type="data" format="sbml" optional="false" label="Strain" help="The structure of metabolites present in the chosen chassis strain in SBML format" />
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
23 <param name="compartment_id" type="text" value="c" label="SBML compartment ID" help="Specify the compartment from which to extract the sink molecules. The default are for BiGG models (cytosol)" >
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
24 <validator type="empty_field" message="SBML compartment ID is required"/>
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
25 </param>
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
26 <section name="adv" title="Advanced Options" expanded="false">
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
27 <param argument="--remove_dead_end" type="boolean" truevalue="--remove_dead_end" falsevalue="" checked="true" label="Remove dead-end metabolites using FVA evaluation?" help="Perform FVA (Flux Variability Analysis) evaluation to remove dead end metabolites" />
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
28 </section>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
29 </inputs>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
30 <outputs>
3
47bb93e7832b "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 2
diff changeset
31 <data name="sink" format="csv" metadata_source="input" label="Sink - ${input.name}" />
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
32 </outputs>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
33 <tests>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
34 <test>
2
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
35 <!-- test 1: check if identical outputs are produced with iCN718 model input -->
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
36 <param name="input" value="iCN718.xml.gz" />
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
37 <output name="sink" file="sink.csv" ftype="csv" compare="diff"/>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
38 </test>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
39 </tests>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
40 <help><![CDATA[
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
41
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
42 Sink from SBML
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
43 =================
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
44
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
45 Sink refers to the collection of chemical species used by the restrosynthesis algorithm of `RetroPath2.0 <https://doi.org/10.1016/j.ymben.2017.12.002>`_ to finish metabolic route exploration. This tool uses an SBML (Systems Biology Markup Language) file of the desired chassis organism, parses all the molecules within a specified compartment (example: cytosol, Golgi apparatus, nucleus, etc) and uses its MIRIAM (Minimal Information Requested In the Annotation of Models) annotation to find their InChI (International Chemical Identifier) structures. In *Advanced Options*, You can use *Remove dead-end metabolites using FVA evaluation?* to conduct Flux Variability Analysis to remove metabolites that lack the requisite flux that would account for their production or consumption within the metabolic network.
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
46
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
47 The user can also specify the compartment from which the tool will extract the chemical species. The default is 'c', the BiGG code for the cytosol. If the user wishes to upload an SBML file from another source, then this value must be changed.
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
48
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
49 The results are written to a RetroPath2.0 friendly CSV file format that can be used as sink input.
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
50
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
51 Input
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
52 -----
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
53
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
54 Required:
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
55
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
56 * **Strain**\ : The structure of metabolites present in the chosen chassis strain in SBML format.
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
57 * **SBML compartment ID**\ : (string, default: c) Specify the compartment from which to extract the sink molecules. The default are for BiGG models (cytosol).
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
58
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
59 Advanced options:
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
60
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
61 * **Remove dead-end metabolites using FVA evaluation?**\ : (boolean, default: True) Perform FVA (Flux Variability Analysis) evaluation to remove dead end metabolites.
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
62
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
63 Output
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
64 ------
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
65
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
66 * **Sink**\ : CSV file containing a collection of chemical species used by the restrosynthesis algorithm of `RetroPath2.0 <https://doi.org/10.1016/j.ymben.2017.12.002>`_.
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
67
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
68 Project Links
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
69 ---------------------
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
70
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
71 * `GitHub <https://github.com/brsynth/rptools>`_
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
72
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
73 License
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
74 -------
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
75
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
76 `MIT <https://github.com/brsynth/rptools/blob/master/LICENSE>`_
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
77
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
78 Acknowledgments
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
79 ---------------
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
80
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
81 * Thomas Duigou
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
82
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
83 ]]></help>
4
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
84 <creator>
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
85 <person givenName="Joan" familyName="Hérisson" email="joan.herisson@univ-evry.fr" identifier="https://orcid.org/0000-0001-9741-0847" />
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
86 <person givenName="Melchior" familyName="du Lac" identifier="https://orcid.org/0000-0002-9984-4689" />
191665a689de planemo upload commit 3bc34bfc82850daa2229724c396dcd9454039273-dirty
tduigou
parents: 3
diff changeset
87 </creator>
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
88 <citations>
2
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
89 <citation type="doi">10.1038/nbt1156</citation>
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
90 <citation type="doi">10.1016/j.ymben.2017.12.002</citation>
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
91 <citation type="doi">10.1186/1752-0509-7-74</citation>
8d16a0f08d0a "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents: 1
diff changeset
92 <citation type="doi">10.1093/bioinformatics/btn051</citation>
1
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
93 </citations>
ceab7bc46740 "planemo upload commit 2f1af427fa4c4f2aad53ab94c4cdb51456c66019-dirty"
tduigou
parents:
diff changeset
94 </tool>