annotate ExtractSubBipNetwork.xml @ 3:dc9011ea45f6 draft default tip

planemo upload for repository https://forge.inrae.fr/metexplore/met4j-galaxy commit e757d0398a8407d983f1ef3f900b31cafc26e170
author metexplore
date Wed, 21 Jan 2026 15:29:07 +0000
parents 56501f9a2a6b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
2 <tool id="met4j_ExtractSubBipNetwork" name="ExtractSubBipNetwork" version="@TOOL_VERSION@">
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
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>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
4 <macros>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
5 <import>macros.xml</import>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
6 </macros>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
7 <expand macro="bio_tools"/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
8 <expand macro="requirements"/>
1
56501f9a2a6b planemo upload for repository https://forge.inrae.fr/metexplore/met4j-galaxy commit 6bb33ff0ff022029543e5e5ace7d16418715aa1c
metexplore
parents: 0
diff changeset
9 <command detect_errors="exit_code"><![CDATA[met4j networkAnalysis.ExtractSubBipNetwork -i "$inputPath"
0
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
10 -s "$sourcePath"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
11 -t "$targetPath"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
12 $undirected
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
13 -sc "$sideCompoundFile"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
14 #if str($blkdReactionFile) != 'None':
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
15 -br "$blkdReactionFile"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
16 #end if
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
17 #if str($weightFile) != 'None':
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
18 -cw "$weightFile"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
19 #end if
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
20 #if str($k):
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
21 -k "$k"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
22 #end if
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
23 $st
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
24 #if str($format):
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
25 -f "$format"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
26 #end if
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
27 -o "$output"
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
28 ]]></command>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
29 <inputs>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
30 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
31 <param argument="-s" format="txt" label="input sources txt file" name="sourcePath" optional="false" type="data" value=""/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
32 <param argument="-t" format="txt" label="input targets txt file" name="targetPath" optional="false" type="data" value=""/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
33 <param argument="-u" checked="false" falsevalue="" label="Ignore reaction direction" name="undirected" truevalue="-u" type="boolean" value="false"/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
34 <param argument="-sc" format="txt" label="a file containing list of side compounds to ignore" name="sideCompoundFile" optional="false" type="data" value=""/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
35 <param argument="-br" format="txt" label="a file containing list of blocked reactions to ignore" name="blkdReactionFile" optional="true" type="data" value=""/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
36 <param argument="-cw" format="tsv" label="an optional file containing weights for reactions pairs" name="weightFile" optional="true" type="data" value=""/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
37 <param argument="-k" label="Extract k-shortest paths" name="k" optional="true" type="text" value="1">
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
38 <sanitizer invalid_char="_">
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
39 <valid initial="string.printable"/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
40 </sanitizer>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
41 </param>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
42 <param argument="-st" checked="false" falsevalue="" label="Extract Steiner Tree" name="st" truevalue="-st" type="boolean" value="false"/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
43 <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">
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
44 <option value="gml">gml</option>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
45 <option selected="true" value="tab">tab</option>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
46 <option value="nodeList">nodeList</option>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
47 <option value="json">json</option>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
48 <option value="matrix">matrix</option>
3
dc9011ea45f6 planemo upload for repository https://forge.inrae.fr/metexplore/met4j-galaxy commit e757d0398a8407d983f1ef3f900b31cafc26e170
metexplore
parents: 1
diff changeset
49 <option value="jsonviz">jsonviz</option>
0
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
50 </param>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
51 </inputs>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
52 <outputs>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
53 <data format="txt" name="output"/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
54 </outputs>
3
dc9011ea45f6 planemo upload for repository https://forge.inrae.fr/metexplore/met4j-galaxy commit e757d0398a8407d983f1ef3f900b31cafc26e170
metexplore
parents: 1
diff changeset
55 <tests/>
0
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
56 <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.
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
57 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.
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
58 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.
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
59 @ATTRIBUTION@]]></help>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
60 <citations/>
96589870be02 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e28ca123295d50b85ba872e5a4720fd72697ecc3
metexplore
parents:
diff changeset
61 </tool>