annotate tools/networkAnalysis/MetaboRank/MetaboRank.xml @ 3:6bd9aad9626d draft

planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit a078bf88575dac3d09462252eae92c24f34d0414
author metexplore
date Fri, 29 Jul 2022 13:23:40 +0000
parents e69a78624877
children ae4c301919c4
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"?>
3
6bd9aad9626d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit a078bf88575dac3d09462252eae92c24f34d0414
metexplore
parents: 2
diff changeset
2 <tool id="met4j_MetaboRank" name="MetaboRank" version="1.1.0">
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
3 <description>Compute the MetaboRank, a custom personalized PageRank for metabolic network.</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>
3
6bd9aad9626d planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit a078bf88575dac3d09462252eae92c24f34d0414
metexplore
parents: 2
diff changeset
8 <container type="singularity">oras://registry.forgemia.inra.fr/metexplore/met4j/met4j-singularity:1.1.0</container>
0
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.MetaboRank -i "$sbmlFilePath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
11 -s "$seedsFilePath"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
12 #if str($edgeWeightsFilePaths) != 'None':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
13 -w "$edgeWeightsFilePaths"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
14 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
15 #if str($maxNbOfIter):
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
16 -max "$maxNbOfIter"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
17 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
18 #if str($tolerance) != 'nan':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
19 -t "$tolerance"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
20 #end if
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
21 #if str($dampingFactor) != 'nan':
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
22 -d "$dampingFactor"
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 -o "$output"
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
25 ]]></command>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
26 <inputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
27 <param argument="-i" format="sbml" label="input SBML file: path to network used for computing centrality, in sbml format." name="sbmlFilePath" optional="false" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
28 <param argument="-s" format="tsv" label="input seeds file: tabulated file containing node of interest ids and weight" name="seedsFilePath" 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="-w" format="tsv" label="input edge weight file: (recommended) path to file containing edges' weights. Will be normalized as transition probabilities" name="edgeWeightsFilePaths" optional="true" type="data" value=""/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
30 <param argument="-max" label="maximal number of iteration" name="maxNbOfIter" optional="true" type="text" value="15000">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
31 <sanitizer invalid_char="_">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
32 <valid initial="string.printable"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
33 </sanitizer>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
34 </param>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
35 <param argument="-t" label="convergence tolerance" name="tolerance" optional="true" type="float" value="0.001"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
36 <param argument="-d" label="damping factor" name="dampingFactor" optional="true" type="float" value="0.85"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
37 </inputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
38 <outputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
39 <data format="tsv" name="output"/>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
40 </outputs>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
41 <tests>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
42 <test>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
43 <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
44 <output ftype="tsv" name="output">
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
45 </output>
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 </tests>
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
48 <help><![CDATA[Compute the MetaboRank, a custom personalized PageRank for metabolic network.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
49 The MetaboRank takes a metabolic network and a list of compounds of interest, and provide a score of relevance for all of the other compounds in the network.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
50 The MetaboRank can, from metabolomics results, be used to fuel a recommender system highlighting interesting compounds to investigate, retrieve missing identification and drive literature mining.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
51 It is a two dimensional centrality computed from personalized PageRank and CheiRank, with special transition probability and normalization to handle the specificities of metabolic networks.
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
52 See publication for more information: Frainay et al. MetaboRank: network-based recommendation system to interpret and enrich metabolomics results, Bioinformatics (35-2), https://doi.org/10.1093/bioinformatics/bty577]]></help>
1
9b162ee6ff8e planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 12798951d21c3b2b13514b38148b2848cb422c95
metexplore
parents: 0
diff changeset
53 <citations/>
0
dcd16521b969 planemo upload for repository https://forgemia.inra.fr/metexplore/met4j-galaxy commit 5dab0a2d83a1fdd7a1878a50ba0f24e752505393
metexplore
parents:
diff changeset
54 </tool>