Mercurial > repos > recetox > xmsannotator_advanced

annotate xmsannotator_advanced.xml @ 3:3bdef6d114fd 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 de75adf885d616bbe94c8087d3208a2b5039418e"
author recetox
date Thu, 08 Oct 2020 00:41:36 +0000
parents 477d579f475b
children 6b2b2b83b46c
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
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
6 <requirements>
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
7 <container type="docker">@DOCKER_IMAGE@</container>
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
8 </requirements>
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
9
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
10 <command detect_errors="aggressive"><![CDATA[
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
11 #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
12 #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
13
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
14 Rscript -e 'annotation <- xmsannotator::advanced_annotation(
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
15 peaks = xmsannotator::load_hdf("$peaks", "peaks"),
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
16 adducts = xmsannotator::load_hdf("$adducts", "adducts"),
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
17 compounds = xmsannotator::load_hdf("$compounds", "compounds"),
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
18
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
19 mass_tolerance = 1e-6 * $mz_tolerance_ppm
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
20 time_tolerance = $rt_tolerance,
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
21
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
22 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
23 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
24 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
25 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
26
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
27 expected_adducts = as.character($expected_adducts),
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
28 #if $scoring.boost
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
29 boost = xmsannotator::load_hdf("$scoring.boost", "boost"),
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
30 #end if
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
31 redundancy_filtering = $scoring.redundancy_filtering
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
32 )'
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
33 -e 'xmsannotator::save_hdf("$annotation", "annotation", annotation)'
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
34 ]]></command>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
35
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
36 <inputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
37 <expand macro="annotation"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
38 <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
39
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
40 <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
41 <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
42 <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
43 <option value="spearman"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
44 </param>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
45 <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
46 <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
47 <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
48 <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
49 <option value="signed"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
50 <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
51 </param>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
52 </section>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
53
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
54 <section name="scoring" title="Scoring" expanded="true">
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
55 <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."/>
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
56 <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
57 <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
58 </repeat>
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
59 <param name="boost" type="data" format="h5" optional="true" label="Validated compounds score boosting (optional)" help="Table of previously validated compounds to boost their scores and confidence levels. The 1st column of the table must contain IDs of compounds. The optional 2nd and 3rd columns may contain mz values and retention times."/>
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
60 <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
61 <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."/>
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
62 <param name="redundancy_filtering" type="boolean" checked="true" truevalue="TRUE" falsevalue="FALSE" label="Redundancy filtering" help="Whether to filter out low-scored multiple matcher or not."/>
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
63 </section>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
64 </inputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
65
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
66 <outputs>
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
67 <data format="h5" name="annotation"/>
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
68 </outputs>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
69
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
70 <help><![CDATA[
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
71 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
72
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
73 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
74 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
75 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
76 ]]></help>
3
3bdef6d114fd "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit de75adf885d616bbe94c8087d3208a2b5039418e"
recetox
parents: 1
diff changeset
77
0
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
78 <expand macro="citations"/>
60aec5c0e1ea "planemo upload for repository https://github.com/RECETOX/galaxytools/tree/master/tools/xmsannotator commit 9c62378416ff3634935e7da4aa97b05d3356d1b5"
recetox
parents:
diff changeset
79 </tool>