annotate build/tools/ExtractSubNetwork/ExtractSubNetwork.xml @ 11:40c15b7467f1 draft default tip

planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
author metexplore
date Thu, 13 Feb 2025 15:08:22 +0000
parents 6a112eaf8f38
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
2 <tool id="met4j_ExtractSubNetwork" name="ExtractSubNetwork" version="2.0.1">
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
3 <description>Create a subnetwork from a metabolic network in SBML format, and two files containing lists of compounds of interests ids, one per row.</description>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
4 <xrefs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
5 <xref type="bio.tools">met4j</xref>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
6 </xrefs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
7 <requirements>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:2.0.1</container>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
9 </requirements>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.ExtractSubNetwork -i "$inputPath"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
11 -s "$sourcePath"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
12 -t "$targetPath"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
13 #if str($sideCompoundFile) != 'None':
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
14 -sc "$sideCompoundFile"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
15 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
16 $degree
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
17 #if str($weightFile) != 'None':
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
18 -cw "$weightFile"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
19 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
20 $chemicalSim
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
21 $undirected
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
22 #if str($k):
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
23 -k "$k"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
24 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
25 $st
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
26 #if str($format):
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
27 -f "$format"
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
28 #end if
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
29 -o "$output"
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
30 ]]></command>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
31 <inputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
32 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
33 <param argument="-s" format="txt" label="input sources txt file" name="sourcePath" optional="false" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
34 <param argument="-t" format="txt" label="input targets txt file" name="targetPath" optional="false" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
35 <param argument="-sc" format="txt" label="an optional file containing list of side compounds to ignore" name="sideCompoundFile" optional="true" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
36 <param argument="-dw" checked="false" falsevalue="" label="penalize traversal of hubs by using degree square weighting" name="degree" truevalue="-dw" type="boolean" value="false"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
37 <param argument="-cw" format="tsv" label="an optional file containing weights for compound pairs" name="weightFile" optional="true" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
38 <param argument="-sw" checked="false" falsevalue="" label="penalize traversal of non-relevant edges by using chemical similarity weighting" name="chemicalSim" truevalue="-sw" type="boolean" value="false"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
39 <param argument="-u" checked="false" falsevalue="" label="Ignore reaction direction" name="undirected" truevalue="-u" type="boolean" value="false"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
40 <param argument="-k" label="Extract k-shortest paths" name="k" optional="true" type="text" value="1">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
41 <sanitizer invalid_char="_">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
42 <valid initial="string.printable"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
43 </sanitizer>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
44 </param>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
45 <param argument="-st" checked="false" falsevalue="" label="Extract Steiner Tree" name="st" truevalue="-st" type="boolean" value="false"/>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
46 <param argument="-f" label="Format of the exported graphTabulated edge list by default (source id &#9; edge type &#9; target id). Other options include GML, JsonGraph, and tabulated node list (label &#9; node id &#9; node type)." name="format" optional="true" type="select" value="tab">
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
47 <option value="gml">gml</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
48 <option selected="true" value="tab">tab</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
49 <option value="nodeList">nodeList</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
50 <option value="json">json</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
51 <option value="matrix">matrix</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
52 </param>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
53 </inputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
54 <outputs>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
55 <data format="txt" name="output"/>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
56 </outputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
57 <tests>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
58 <test>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
59
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
60 <param name="inputPath" value="toy_model.xml"/>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
61
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
62 <param name="sourcePath" value="seeds.txt"/>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
63
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
64 <param name="targetPath" value="targets.txt"/>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
65
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
66 <param name="format" value="gml"/>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
67
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
68 <output ftype="txt" name="output">
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
69
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
70 <assert_contents>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
71
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
72 <has_line_matching expression=".*node.*" n="3"/>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
73
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
74 <has_line_matching expression=".*edge.*" n="2"/>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
75
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
76 </assert_contents>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
77
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
78 </output>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
79
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
80 </test>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
81 </tests>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
82 <help><![CDATA[Create a subnetwork from a metabolic network in SBML format, and two files containing lists of compounds of interests ids, one per row.
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
83 The subnetwork corresponds to the part of the network that connects compounds from the first list to compounds from the second list.
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
84 Sources and targets list can have elements in common. The connecting part can be defined as the union of shortest or k-shortest paths between sources and targets, or the Steiner tree connecting them. The relevance of considered path can be increased by weighting the edges using degree squared, chemical similarity (require InChI or SMILES annotations) or any provided weighting.
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
85
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
86 See previous works on subnetwork extraction for parameters recommendations.]]></help>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
87 <citations>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
88 <citation type="doi">10.1093/nar/gki437</citation>
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
89 <citation type="doi">10.1093/bioinformatics/btg217</citation>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
90 <citation type="doi">10.1093/bib/bbv115</citation>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
91 <citation type="doi">10.1016/j.biosystems.2011.05.004</citation>
11
40c15b7467f1 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 61dbdbae896d18b519a470e056cb8b4f98394518
metexplore
parents: 10
diff changeset
92 <citation type="doi">10.1093/bioinformatics/bti116</citation>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
93 <citation type="doi">10.1016/j.jmb.2005.09.079</citation>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
94 <citation type="doi">10.1093/bioinformatics/btu760</citation>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
95 </citations>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
96 </tool>