Mercurial > repos > recetox > xmsannotator_advanced

annotate xmsannotator_advanced.xml @ 0:60aec5c0e1ea draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
author recetox
date Wed, 23 Sep 2020 13:32:17 +0000
parents
children 477d579f475b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
1 <tool id="xmsannotator_advanced" name="xMSannotator (advanced)" version="@TOOL_VERSION@+galaxy0">
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
2 <macros>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
3 <import>xmsannotator_macros.xml</import>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
4 </macros>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
5
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
6 <expand macro="requirements"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
7
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
9 #set expected_adducts = ['"{}"'.format($i.adduct) for $i in $scoring.expected_adducts]
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
10 #set expected_adducts = "c(" + ', '.join($expected_adducts) + ")"
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
11
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
12 Rscript -e 'annotation <- xmsannotator::advanced_annotation(
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
13 peaks = rhdf5::h5read("$peaks", "peaks"),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
14 adducts = rhdf5::h5read("$adducts", "adducts"),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
15 metabolites = rhdf5::h5read("$metabolites", "metabolites"),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
16
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
17 mz_tolerance_ppm = as.double($mz_tolerance_ppm),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
18 rt_tolerance = as.double($rt_tolerance),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
19
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
20 correlation_threshold = as.double($clustering.correlation_threshold),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
21 min_cluster_size = as.integer($clustering.min_cluster_size),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
22 deep_split = as.integer($clustering.deep_split),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
23 network_type = "$clustering.network_type",
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
24
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
25 #if $scoring.boost_metabolites
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
26 boost_metabolites = rhdf5::h5read("$scoring.boost_metabolites", "boost_metabolites"),
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
27 #end if
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
28
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
29 expected_adducts = as.character($expected_adducts)
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
30 )'
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
31 -e 'rhdf5::h5write(annotation, "$annotation", "annotation")'
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
32 ]]></command>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
33
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
34 <inputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
35 <expand macro="annotation"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
36 <param name="rt_tolerance" type="float" value="10" min="0" label="Retention time tolerance [s]" help="Retention time tolerance in seconds for finding peaks derived from the same parent metabolite."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
37
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
38 <section name="clustering" title="Clustering">
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
39 <param name="correlation_method" type="select" display="radio" label="Correlation method">
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
40 <option value="pearson" selected="true"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
41 <option value="spearman"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
42 </param>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
43 <param name="correlation_threshold" type="float" value="0.7" label="Correlation threshold" help="Correlation threshold between peaks to qualify as adducts/isotopes of the same metabolite."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
44 <param name="min_cluster_size" type="integer" value="10" min="1" label="Minimum cluster size" help="The minimum number of nodes to be considered as a cluster."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
45 <param name="deep_split" type="integer" value="2" min="0" max="4" label="Deep split" help="Deep split provides a rough control over sensitivity to cluster splitting. The higher the value, the more and smaller clusters will be produced (see WGCNA package documentation)."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
46 <param name="network_type" type="select" display="radio" label="Network type" help="Network type parameter affects how the network's adjacency matrix is created from the correlation matrix (see WGCNA package documentation).">
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
47 <option value="signed"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
48 <option value="unsigned" selected="true"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
49 </param>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
50 </section>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
51
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
52 <section name="scoring" title="Scoring" expanded="true">
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
53 <param name="boost_metabolites" type="data" format="h5" optional="true" label="Validated metabolites score boosting (optional)" help="Table of previously validated metabolites to boost their confidence scores. The 1st column of the table must contain IDs of metabolites. The optional 2nd and 3rd columns may contain mz values and retention times."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
54 <repeat name="expected_adducts" title="Expected adducts" help="Require the presence of certain adducts for a high confidence match.">
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
55 <param name="adduct" type="text" value="M+H" label="Adduct"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
56 </repeat>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
57 <param name="min_isp" type="integer" min="0" value="1" label="Minimum number of expected isotopes" help="Minimum number of adducts/isotopes to be present for a match to be considered as a high confidence match."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
58 <param name="max_isp" type="integer" min="0" value="5" label="Maximum number of expected isotopes" help="Maximum number of adducts/isotopes to be present for a match to be considered as a high confidence match."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
59 <param name="strict_boosting" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Strict boosting" help="Boost the scores of metabolites that not only belongs to the same pathway but also to the same cluster. Otherwise, do not account for cluster membership."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
60 <param name="redundancy_filtering" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Redundancy filtering" help="Whether to perform final redundancy filtering or not."/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
61 </section>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
62 </inputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
63
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
64 <outputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
65 <expand macro="output"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
66 </outputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
67
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
68 <help><![CDATA[
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
69 Annotate the peak intensity table (such as outputted from apLCMS) with metabolites from the metabolite database using advanced methods.
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
70
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
71 The annotation process generates all possible metabolite-adduct pairs from the metabolite and adduct databases and matches those pairs to the measured peaks.
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
72 A metabolite-adduct pair is pronounced as a match to the peak when the difference of their masses are withing some tolerance.
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
73 Then a score and a confidence level is assigned to each match based on peak correlation clustering, metabolite pathway associations, adducts expectations, and isotope conformations.
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
74 ]]></help>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
75 <expand macro="citations"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
76 </tool>