annotate tools/networkAnalysis/TopologicalPathwayAnalysis/TopologicalPathwayAnalysis.xml @ 8:1274e2a62479 draft default tip

planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
author metexplore
date Wed, 26 Jul 2023 15:33:45 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
2 <tool id="met4j_TopologicalPathwayAnalysis" name="TopologicalPathwayAnalysis" version="MET4J_VERSION_TEST">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
3 <description>Run a Topological Pathway Analysis to identify key pathways based on topological properties of its constituting compounds.</description>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
4 <xrefs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
5 <xref type="bio.tools">met4j</xref>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
6 </xrefs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
7 <requirements>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:MET4J_VERSION_TEST</container>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
9 </requirements>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
10 <command detect_errors="exit_code"><![CDATA[sh /usr/bin/met4j.sh networkAnalysis.TopologicalPathwayAnalysis -s "$inputPath"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
11 #if str($inputSide) != 'None':
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
12 -sc "$inputSide"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
13 #end if
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
14 #if str($mergingStrat):
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
15 -mc "$mergingStrat"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
16 #end if
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
17 $removeIsolated
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
18 #if str($weightFile) != 'None':
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
19 -cw "$weightFile"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
20 #end if
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
21 $undirected
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
22 -noi "$dataPath"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
23 $out
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
24 -o "$outputPath"
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
25 ]]></command>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
26 <inputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
27 <param argument="-s" format="sbml" label="input SBML file" name="inputPath" optional="false" type="data" value=""/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
28 <param argument="-sc" format="txt" label="input Side compound file (recommended)" name="inputSide" optional="true" type="data" value=""/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
29 <param argument="-mc" label="merge compartments. Use names if consistent and unambiguous across compartments, or identifiers if compartment suffix is present (id in form &quot;xxx_y&quot; with xxx as base identifier and y as compartment label)." name="mergingStrat" optional="true" type="select" value="no">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
30 <option selected="true" value="no">no</option>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
31 <option value="by_name">by_name</option>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
32 <option value="by_id">by_id</option>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
33 </param>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
34 <param argument="-ri" checked="false" falsevalue="" label="remove isolated nodes" name="removeIsolated" truevalue="-ri" type="boolean" value="false"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
35 <param argument="-cw" format="tsv" label="an optional file containing weights for compound pairs, taken into account for betweenness computation. Edges not found in file will be removed" name="weightFile" optional="true" type="data" value=""/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
36 <param argument="-un" checked="false" falsevalue="" label="the compound graph built from the metabolic network and used for computations will undirected, i.e. the reaction directions won't be taken into account" name="undirected" truevalue="-un" type="boolean" value="false"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
37 <param argument="-noi" format="txt" label="file containing the list of metabolites of interests (one per line)" name="dataPath" optional="false" type="data" value=""/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
38 <param argument="-out" checked="false" falsevalue="" label="use out-degree as scoring function instead of betweenness (faster computation)" name="out" truevalue="-out" type="boolean" value="false"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
39 </inputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
40 <outputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
41 <data format="tsv" name="outputPath"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
42 </outputs>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
43 <tests>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
44 <test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
45 <param name="inputPath" value="XF_network.sbml"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
46 <param name="dataPath" value="XF_network_C_NOI.txt"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
47 <param name="inputSide" value="XF_network_C_Side.tab"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
48 <output name="outputPath">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
49 <assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
50 <has_n_columns n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
51 <has_n_lines n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
52 </assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
53 </output>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
54 </test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
55 <test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
56 <param name="inputPath" value="XF_network.sbml"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
57 <param name="dataPath" value="XF_network_C_NOI.txt"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
58 <param name="inputSide" value="XF_network_C_Side.tab"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
59 <param name="undirected" value="true"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
60 <param name="removeIsolated" value="true"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
61 <param name="out" value="true"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
62 <param name="mergingStrat" value="by_id"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
63 <output name="outputPath">
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
64 <assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
65 <has_n_columns n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
66 <has_n_lines n="3"/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
67 </assert_contents>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
68 </output>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
69 </test>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
70 </tests>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
71 <help><![CDATA[Run a Topological Pathway Analysis (TPA) to identify key pathways based on topological properties of its mapped compounds. From a list of compounds of interest, the app compute their betweenness centrality (which quantifies how often a compound acts as a intermediary along the shortest paths between pairs of other compounds in the network, which, if high, suggest a critical role in the overall flow within the network). Each pathway is scored according to the summed centrality of its metabolites found in the dataset. Alternatively to the betweenness, one can make use of the out-degree (the number of outgoing link, i.e. number of direct metabolic product) as a criterion of importance. TPA is complementary to statistical enrichment analysis to ensures a more meaningful interpretation of the data, by taking into account the influence of identified compounds on the structure of the pathways.]]></help>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
72 <citations/>
1274e2a62479 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit e34acf0f51cafcf6ae7c97b4feb3188a39f17c32
metexplore
parents:
diff changeset
73 </tool>