annotate MassTraceExtractor.xml @ 1:17e8c91b70d5 draft

Uploaded
author bgruening
date Fri, 10 Oct 2014 18:23:01 -0400
parents 3d84209d3178
children 6ead64a594bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
2 <tool id="MassTraceExtractor" name="MassTraceExtractor" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Detects mass traces in centroided LC-MS data.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">MassTraceExtractor</token>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
7 </macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
10 <command>MassTraceExtractor
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -out_type ${param_out_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -algorithm:common:noise_threshold_int ${param_noise_threshold_int}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 -algorithm:common:chrom_peak_snr ${param_chrom_peak_snr}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -algorithm:common:chrom_fwhm ${param_chrom_fwhm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 -algorithm:mtd:mass_error_ppm ${param_mass_error_ppm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 ${param_reestimate_mt_sd}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 -algorithm:epd:width_filtering ${param_width_filtering}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 ${param_enabled}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 #if $adv_opts.adv_opts_selector=='advanced':
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 -algorithm:mtd:trace_termination_criterion ${adv_opts.param_trace_termination_criterion}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 -algorithm:mtd:trace_termination_outliers ${adv_opts.param_trace_termination_outliers}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 -algorithm:mtd:min_sample_rate ${adv_opts.param_min_sample_rate}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 -algorithm:mtd:min_trace_length ${adv_opts.param_min_trace_length}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 -algorithm:mtd:max_trace_length ${adv_opts.param_max_trace_length}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 -algorithm:epd:min_fwhm ${adv_opts.param_min_fwhm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 -algorithm:epd:max_fwhm ${adv_opts.param_max_fwhm}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 ${adv_opts.param_masstrace_snr_filtering}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 #end if
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <param name="param_in" type="data" format="mzML" optional="False" label="input centroided mzML file" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 <param name="param_out_type" type="select" optional="True" label="output file type -- default: determined from file extension or content" help="(-out_type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <option value="featureXML">featureXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <option value="consensusXML">consensusXML</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <param name="param_noise_threshold_int" type="float" value="10.0" label="Intensity threshold below which peaks are regarded as noise." help="(-noise_threshold_int)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 <param name="param_chrom_peak_snr" type="float" value="3.0" label="Minimum signal-to-noise a mass trace should have." help="(-chrom_peak_snr)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 <param name="param_chrom_fwhm" type="float" value="5.0" label="Expected chromatographic peak width (in seconds)." help="(-chrom_fwhm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <param name="param_mass_error_ppm" type="float" value="20.0" label="Allowed mass deviation (in ppm)." help="(-mass_error_ppm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <param name="param_reestimate_mt_sd" type="boolean" truevalue="-algorithm:mtd:reestimate_mt_sd true" falsevalue="-algorithm:mtd:reestimate_mt_sd false" checked="true" optional="True" label="Enables dynamic re-estimation of m/z variance during mass trace collection stage." help="(-reestimate_mt_sd)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <param name="param_width_filtering" type="select" optional="True" value="fixed" label="Enable filtering of unlikely peak widths. The fixed setting filters out mass traces outside the [min_fwhm, max_fwhm] interval (set parameters accordingly!). The auto setting filters with the 5 and 95% quantiles of the peak width distribution." help="(-width_filtering)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 <option value="off">off</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 <option value="fixed">fixed</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 <option value="auto">auto</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 <param name="param_enabled" type="boolean" truevalue="-algorithm:epd:enabled true" falsevalue="-algorithm:epd:enabled false" checked="true" optional="True" label="Enables/disables the chromatographic peak detection of mass traces" help="(-enabled)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 <expand macro="advanced_options">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52 <param name="param_trace_termination_criterion" type="select" optional="True" value="outlier" label="Termination criterion for the extension of mass traces. In 'outlier' mode, trace extension cancels if a predefined number of consecutive outliers are found (see trace_termination_outliers parameter). In 'sample_rate' mode, trace extension in both directions stops if ratio of found peaks versus visited spectra falls below the 'min_sample_rate' threshold." help="(-trace_termination_criterion)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53 <option value="outlier">outlier</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54 <option value="sample_rate">sample_rate</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56 <param name="param_trace_termination_outliers" type="integer" value="5" label="Mass trace extension in one direction cancels if this number of consecutive spectra with no detectable peaks is reached." help="(-trace_termination_outliers)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 <param name="param_min_sample_rate" type="float" value="0.5" label="Minimum fraction of scans along the mass trace that must contain a peak." help="(-min_sample_rate)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 <param name="param_min_trace_length" type="float" value="5.0" label="Minimum expected length of a mass trace (in seconds)." help="(-min_trace_length)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59 <param name="param_max_trace_length" type="float" value="300.0" label="Minimum expected length of a mass trace (in seconds)." help="(-max_trace_length)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
60 <param name="param_min_fwhm" type="float" value="3.0" label="Minimum full-width-at-half-maximum of chromatographic peaks (in seconds). Ignored if paramter width_filtering is off or auto." help="(-min_fwhm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
61 <param name="param_max_fwhm" type="float" value="60.0" label="Maximum full-width-at-half-maximum of chromatographic peaks (in seconds). Ignored if paramter width_filtering is off or auto." help="(-max_fwhm)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
62 <param name="param_masstrace_snr_filtering" type="boolean" truevalue="-algorithm:epd:masstrace_snr_filtering true" falsevalue="-algorithm:epd:masstrace_snr_filtering false" checked="false" optional="True" label="Apply post-filtering by signal-to-noise ratio after smoothing." help="(-masstrace_snr_filtering)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
63 </expand>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
64 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
65 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
66 <data name="param_out" label="output featureXML file with mass traces" format="consensusXML">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
67 <change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
68 <when input="param_out_type" value="featureXML" format="featureXML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
69 </change_format>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
70 </data>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
71 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
72 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
73
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
74 Detects mass traces in centroided LC-MS data.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
75
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
76
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
77 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_MassTraceExtractor.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
78
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
79 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
80 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
81 </tool>