annotate tools/networkAnalysis/ExtractSubNetwork/ExtractSubNetwork.xml @ 0:dcd16521b969 draft

planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
author metexplore
date Fri, 10 Jun 2022 10:31:34 +0000
parents
children 9b162ee6ff8e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
2 <tool id="met4j_ExtractSubNetwork" name="ExtractSubNetwork" version="0.11.0">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
3 <description>Create a subnetwork from a GSMN in SBML format, and two files containing lists of compounds of interests ids, one per row.</description>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
4 <xrefs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
5 <xref type="bio.tools">met4j</xref>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
6 </xrefs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
7 <requirements>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:0.11.0</container>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
9 </requirements>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.ExtractSubNetwork -i "$inputPath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
11 -s "$sourcePath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
12 -t "$targetPath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
13 #if str($sideCompoundFile) != 'None':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
14 -sc "$sideCompoundFile"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
15 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
16 $degree
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
17 #if str($weightFile) != 'None':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
18 -cw "$weightFile"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
19 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
20 $chemicalSim
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
21 #if str($k):
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
22 -k "$k"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
23 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
24 $st
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
25 -o "$outputPath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
26 ]]></command>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
27 <inputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
28 <param argument="-i" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
29 <param argument="-s" format="text" label="input sources txt file" name="sourcePath" optional="false" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
30 <param argument="-t" format="text" label="input targets txt file" name="targetPath" optional="false" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
31 <param argument="-sc" format="text" label="an optional file containing list of side compounds to ignore" name="sideCompoundFile" optional="true" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
32 <param argument="-dw" checked="false" falsevalue="" label="penalize traversal of hubs by using degree square weighting" name="degree" truevalue="-dw" type="boolean" value="false"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
33 <param argument="-cw" format="tsv" label="an optional file containing weights for compound pairs" name="weightFile" optional="true" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
34 <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"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
35 <param argument="-k" label="Extract k-shortest paths" name="k" optional="true" type="text" value="1">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
36 <sanitizer invalid_char="_">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
37 <valid initial="string.printable"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
38 </sanitizer>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
39 </param>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
40 <param argument="-st" checked="false" falsevalue="" label="Extract Steiner Tree" name="st" truevalue="-st" type="boolean" value="false"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
41 </inputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
42 <outputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
43 <data format="gml" name="outputPath"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
44 </outputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
45 <tests>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
46 <test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
47 <param name="inputPath" value="toy_model.xml"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
48 <param name="sourcePath" value="seeds.txt"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
49 <param name="targetPath" value="targets.txt"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
50 <output ftype="gml" name="outputPath">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
51 <assert_contents>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
52 <has_line_matching expression=".*node.*" n="3"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
53 <has_line_matching expression=".*edge.*" n="2"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
54 </assert_contents>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
55 </output>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
56 </test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
57 </tests>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
58 <help><![CDATA[Create a subnetwork from a GSMN in SBML format, and two files containing lists of compounds of interests ids, one per row.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
59 The subnetwork correspond to part of the network that connects compounds from the first list to compounds from the second list.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
60 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.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
61
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
62 See previous works on subnetwork extraction for parameters recommendations:Frainay, C., & Jourdan, F. Computational methods to identify metabolic sub-networks based on metabolomic profiles. Bioinformatics 2016;1–14. https://doi.org/10.1093/bib/bbv115
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
63 Faust, K., Croes, D., & van Helden, J. Prediction of metabolic pathways from genome-scale metabolic networks. Bio Systems 2011;105(2), 109–121. https://doi.org/10.1016/j.biosystems.2011.05.004
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
64 Croes D, Couche F, Wodak SJ, et al. Metabolic PathFinding: inferring relevant pathways in biochemical networks. Nucleic Acids Res 2005;33:W326–30.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
65 Croes D, Couche F, Wodak SJ, et al. Inferring meaningful pathways in weighted metabolic networks. J Mol Biol 2006; 356:222–36.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
66 Rahman SA, Advani P, Schunk R, et al. Metabolic pathway analysis web service (Pathway Hunter Tool at CUBIC). Bioinformatics 2005;21:1189–93.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
67 Pertusi DA, Stine AE, Broadbelt LJ, et al. Efficient searching and annotation of metabolic networks using chemical similarity. Bioinformatics 2014;1–9.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
68 McShan DC, Rao S, Shah I. PathMiner: predicting metabolic pathways by heuristic search. Bioinformatics 2003;19:1692–8.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
69 ]]></help>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
70 </tool>