annotate metams_lcms_annotate.xml @ 41:e67149fbff20

small changes/improvements; new metams and xcms tools
author pieter.lukasse@wur.nl
date Thu, 06 Nov 2014 16:14:44 +0100
parents
children f772a5caa86a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
41
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
1 <tool id="metams_lcms_annotate" name="METAMS-LC/MS Annotate" version="0.0.3">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
2 <description> Runs metaMS process for LC/MS feature grouping and annotation</description>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
3 <requirements>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
4 <requirement type="package" version="3.1.1">R_bioc_metams</requirement>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
5 </requirements>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
6 <command interpreter="Rscript">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
7 metaMS_cmd_interface.r
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
8 $constructed_db
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
9 $data_files
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
10 $customMetaMSsettings
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
11 $outputFile
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
12 $outputLog
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
13 $xsetOut
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
14 $htmlReportFile
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
15 $htmlReportFile.files_path
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
16 </command>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
17 <inputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
18 <param name="constructed_db" type="select" label="Constructed DB" help="Reference annotation database generated from matching measurements of a mixture of chemical standards
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
19 against a manually validated reference table which contains the key analytical information for each standard."
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
20 dynamic_options='get_directory_files("tool-data/shared/PRIMS-metabolomics/metaMS")'/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
21
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
22 <param name="data_files" type="data" format="prims.fileset.zip" label="Data files (.zip file with CDFs)" help=".zip file containing the CDF files of the new measurements"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
23
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
24
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
25
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
26 <param name="protocolName" type="text" size="30" label="protocolName" value="Synapt.QTOF.RP" help="protocolName"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
27
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
28 <param name="method" type="select" size="30" label="PEAK PICKING method =====================================================">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
29 <option value="matchedFilter" selected="true">matchedFilter</option>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
30 </param>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
31 <param name="step" type="float" size="10" value="0.05" label="step" help="step"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
32 <param name="fwhm" type="integer" size="10" value="20" label="fwhm" help="fwhm" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
33 <param name="snthresh" type="integer" size="10" value="4" label="snthresh" help="snthresh" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
34 <param name="max" type="integer" size="10" value="50" label="max" help="max" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
35
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
36 <param name="min_class_fraction" type="float" size="10" value="0.3" label="ALIGNMENT min.class.fraction =====================================================" help="min.class.fraction"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
37 <param name="min_class_size" type="integer" size="10" value="3" label="min.class.size" help="min.class.size" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
38 <param name="mzwid" type="float" size="10" value="0.1" label="mzwid" help="mzwid"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
39 <param name="bws" type="text" size="10" value="30,10" label="bws" help="bws"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
40 <param name="missingratio" type="float" size="10" value="0.2" label="missingratio" help="missingratio"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
41 <param name="extraratio" type="float" size="10" value="0.1" label="extraratio" help="extraratio"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
42 <param name="retcormethod" type="select" size="30" label="retcormethod" help="retcormethod">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
43 <option value="linear" selected="true">linear</option>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
44 </param>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
45 <param name="retcorfamily" type="select" size="30" label="retcorfamily" help="retcorfamily">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
46 <option value="symmetric" selected="true">symmetric</option>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
47 </param>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
48 <param name="fillPeaks" type="select" size="30" label="fillPeaks" help="fillPeaks">
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
49 <option value="TRUE" selected="true">Yes</option>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
50 <option value="FALSE">No</option>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
51 </param>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
52 <param name="perfwhm" type="float" size="10" value="0.6" label="CAMERA perfwhm =====================================================" help="perfwhm"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
53 <param name="cor_eic_th" type="float" size="10" value="0.7" label="cor_eic_th" help="cor_eic_th" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
54 <param name="ppm" type="float" size="10" value="5.0" label="ppm" help="ppm" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
55 <param name="rtdiff" type="float" size="10" value="1.5" label="MATCH2DB rtdiff =====================================================" help="rtdiff"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
56 <param name="rtval" type="float" size="10" value="0.1" label="rtval" help="rtval" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
57 <param name="mzdiff" type="float" size="10" value="0.005" label="mzdiff" help="mzdiff" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
58 <param name="match2DB_ppm" type="float" size="10" value="5.0" label="ppm" help="ppm" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
59 <param name="minfeat" type="integer" size="10" value="2" label="minfeat" help="minfeat" />
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
60
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
61 </inputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
62 <configfiles>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
63
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
64 <configfile name="customMetaMSsettings">## start comment
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
65 ## metaMS process settings
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
66 customMetaMSsettings &lt;- metaMSsettings(protocolName = "${protocolName}",
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
67 chrom = "LC",
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
68 PeakPicking = list(
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
69 method = "${method}",
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
70 step = ${step},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
71 fwhm = ${fwhm},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
72 snthresh = ${snthresh},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
73 max = ${max}),
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
74 Alignment = list(
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
75 min.class.fraction = ${min_class_fraction},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
76 min.class.size = ${min_class_size},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
77 mzwid = ${mzwid},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
78 bws = c(${bws}),
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
79 missingratio = ${missingratio},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
80 extraratio = ${extraratio},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
81 retcormethod = "${retcormethod}",
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
82 retcorfamily = "${retcorfamily}",
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
83 fillPeaks = ${fillPeaks}),
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
84 CAMERA = list(
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
85 perfwhm = ${perfwhm},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
86 cor_eic_th = ${cor_eic_th},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
87 ppm= ${ppm}))
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
88 metaSetting(customMetaMSsettings, "match2DB") &lt;- list(
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
89 rtdiff = ${rtdiff},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
90 rtval = ${rtval},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
91 mzdiff = ${mzdiff},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
92 ppm = ${match2DB_ppm},
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
93 minfeat = ${minfeat})</configfile>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
94
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
95 </configfiles>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
96
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
97 <outputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
98 <data name="outputFile" format="tabular" label="${tool.name} on ${on_string} - metaMS annotated file (TSV)"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
99 <data name="outputLog" format="txt" label="${tool.name} on ${on_string} - metaMS LOG"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
100 <data name="xsetOut" format="rdata" label="${tool.name} on ${on_string} - metaMS xcmsSet (RDATA)"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
101 <data name="htmlReportFile" format="html" label="${tool.name} on ${on_string} - metaMS report (HTML)"/>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
102 </outputs>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
103 <tests>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
104 <test>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
105 </test>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
106 </tests>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
107 <code file="match_library.py" /> <!-- file containing get_directory_files function used above-->
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
108 <help>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
109
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
110 .. class:: infomark
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
111
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
112 Runs metaMS process for LC/MS feature grouping and annotation. Parts of the metaMS process also make use of the XCMS and CAMERA tools and algorithms.
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
113 The figure below shows the main parts of the metaMS process.
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
114
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
115 .. image:: $PATH_TO_IMAGES/metaMS.png
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
116
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
117
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
118 **References**
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
119
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
120 If you use this Galaxy tool in work leading to a scientific publication please
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
121 cite the following papers:
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
122
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
123 Wehrens, R.; Weingart, G.; Mattivi, F. (2014).
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
124 metaMS: an open-source pipeline for GC-MS-based untargeted metabolomics.
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
125 Journal of chromatography B: biomedical sciences and applications, 996 (1): 109-116.
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
126 doi: 10.1016/j.jchromb.2014.02.051
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
127 handle: http://hdl.handle.net/10449/24012
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
128
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
129
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
130 </help>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
131 <citations>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
132 <citation type="doi">10.1016/j.jchromb.2014.02.051</citation> <!-- example
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
133 see also https://wiki.galaxyproject.org/Admin/Tools/ToolConfigSyntax#A.3Ccitations.3E_tag_set
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
134 -->
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
135 </citations>
e67149fbff20 small changes/improvements;
pieter.lukasse@wur.nl
parents:
diff changeset
136 </tool>