annotate build/tools/ExtractSubBipNetwork/ExtractSubBipNetwork.xml @ 10:6a112eaf8f38 draft

planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 71071300dd662ad01bd064abcf6866a192eeea95
author metexplore
date Mon, 03 Feb 2025 15:59:46 +0000
parents 0976a6257300
children 40c15b7467f1
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"?>
10
6a112eaf8f38 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 71071300dd662ad01bd064abcf6866a192eeea95
metexplore
parents: 9
diff changeset
2 <tool id="met4j_ExtractSubBipNetwork" name="ExtractSubBipNetwork" version="2.0.0">
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 and/or reactions of interests ids, one per row, plus one file of the same format containing side compounds ids.</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>
10
6a112eaf8f38 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 71071300dd662ad01bd064abcf6866a192eeea95
metexplore
parents: 9
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:2.0.0</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.ExtractSubBipNetwork -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 $undirected
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 #if str($blkdReactionFile) != 'None':
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
16 -br "$blkdReactionFile"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
17 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
18 #if str($weightFile) != 'None':
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
19 -cw "$weightFile"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
20 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
21 #if str($k):
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
22 -k "$k"
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
23 #end if
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
24 $st
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
25 #if str($format):
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
26 -f "$format"
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
27 #end if
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
28 -o "$output"
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
29 ]]></command>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
30 <inputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
31 <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
32 <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
33 <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
34 <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
35 <param argument="-sc" format="txt" label="a file containing list of side compounds to ignore" name="sideCompoundFile" optional="false" type="data" value=""/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
36 <param argument="-br" format="txt" label="a file containing list of blocked reactions to ignore" name="blkdReactionFile" optional="true" type="data" value=""/>
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 reactions 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="-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
39 <sanitizer invalid_char="_">
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
40 <valid initial="string.printable"/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
41 </sanitizer>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
42 </param>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
43 <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
44 <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
45 <option value="gml">gml</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
46 <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
47 <option value="nodeList">nodeList</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
48 <option value="json">json</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
49 <option value="matrix">matrix</option>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
50 </param>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
51 </inputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
52 <outputs>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
53 <data format="txt" name="output"/>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
54 </outputs>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
55 <tests>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
56 <test>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
57 <param name="inputPath" value="toy_model.xml"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
58 <param name="sourcePath" value="seeds.txt"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
59 <param name="targetPath" value="targets.txt"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
60 <param name="sideCompoundFile" value="sc.txt"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
61 <param name="format" value="gml"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
62 <output ftype="txt" name="output">
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
63 <assert_contents>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
64 <has_line_matching expression=".*node.*" n="5"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
65 <has_line_matching expression=".*edge.*" n="4"/>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
66 </assert_contents>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
67 </output>
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
68 </test>
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
69 </tests>
9
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
70 <help><![CDATA[Create a subnetwork from a metabolic network in SBML format, and two files containing lists of compounds and/or reactions of interests ids, one per row, plus one file of the same format containing side compounds ids.
0976a6257300 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 05db35f63cadb9d56dafff594a3507c59cd85273
metexplore
parents: 8
diff changeset
71 The subnetwork corresponds to the part of the network that connects reactions and compounds from the first list to reactions and compounds from the second list.
6
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
72 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. Contrary to compound graph, bipartite graph often lacks weighting policy for edge relevance. In order to ensure appropriate network density, a list of side compounds and blocked reactions to ignore during path build must be provided. An optional edge weight file, if available, can also be used.]]></help>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
73 <citations/>
7a6f2380fc1d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy
metexplore
parents:
diff changeset
74 </tool>