annotate MassTraceExtractor.xml @ 4:60a33af52042 draft default tip

Uploaded
author galaxyp
date Wed, 13 May 2015 21:19:44 -0400
parents 3070d71e0e5c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
2 <tool id="MassTraceExtractor" name="MassTraceExtractor" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Detects mass traces in centroided LC-MS data.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">MassTraceExtractor</token>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
7 </macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
10 <command>MassTraceExtractor
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 #if $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 -in $param_in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #if $param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16 -out $param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 #if $param_out_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -out_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #if " " in str($param_out_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 "$param_out_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 $param_out_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #if $param_algorithm_common_noise_threshold_int:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 -algorithm:common:noise_threshold_int $param_algorithm_common_noise_threshold_int
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #if $param_algorithm_common_chrom_peak_snr:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 -algorithm:common:chrom_peak_snr $param_algorithm_common_chrom_peak_snr
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #if $param_algorithm_common_chrom_fwhm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 -algorithm:common:chrom_fwhm $param_algorithm_common_chrom_fwhm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #if $param_algorithm_mtd_mass_error_ppm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 -algorithm:mtd:mass_error_ppm $param_algorithm_mtd_mass_error_ppm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $param_algorithm_mtd_reestimate_mt_sd:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -algorithm:mtd:reestimate_mt_sd
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_algorithm_epd_width_filtering:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -algorithm:epd:width_filtering
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #if " " in str($param_algorithm_epd_width_filtering):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 "$param_algorithm_epd_width_filtering"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 $param_algorithm_epd_width_filtering
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #if $param_algorithm_epd_enabled:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 -algorithm:epd:enabled
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $adv_opts.param_algorithm_mtd_trace_termination_criterion:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -algorithm:mtd:trace_termination_criterion
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #if " " in str($adv_opts.param_algorithm_mtd_trace_termination_criterion):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 "$adv_opts.param_algorithm_mtd_trace_termination_criterion"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 $adv_opts.param_algorithm_mtd_trace_termination_criterion
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 #if $adv_opts.param_algorithm_mtd_trace_termination_outliers:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 -algorithm:mtd:trace_termination_outliers $adv_opts.param_algorithm_mtd_trace_termination_outliers
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 #if $adv_opts.param_algorithm_mtd_min_sample_rate:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 -algorithm:mtd:min_sample_rate $adv_opts.param_algorithm_mtd_min_sample_rate
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #if $adv_opts.param_algorithm_mtd_min_trace_length:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 -algorithm:mtd:min_trace_length $adv_opts.param_algorithm_mtd_min_trace_length
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 #if $adv_opts.param_algorithm_mtd_max_trace_length:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 -algorithm:mtd:max_trace_length $adv_opts.param_algorithm_mtd_max_trace_length
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 #if $adv_opts.param_algorithm_epd_min_fwhm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 -algorithm:epd:min_fwhm $adv_opts.param_algorithm_epd_min_fwhm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 #if $adv_opts.param_algorithm_epd_max_fwhm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 -algorithm:epd:max_fwhm $adv_opts.param_algorithm_epd_max_fwhm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 #if $adv_opts.param_algorithm_epd_masstrace_snr_filtering:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 -algorithm:epd:masstrace_snr_filtering
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 <param name="param_in" type="data" format="mzml" optional="False" label="input centroided mzML file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 <param name="param_out_type" type="select" optional="True" label="output file type -- default: determined from file extension or content" help="(-out_type) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <option value="featureXML">featureXML</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <option value="consensusXML">consensusXML</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <param name="param_algorithm_common_noise_threshold_int" type="float" value="10.0" label="Intensity threshold below which peaks are regarded as noise" help="(-noise_threshold_int) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <param name="param_algorithm_common_chrom_peak_snr" type="float" value="3.0" label="Minimum signal-to-noise a mass trace should have" help="(-chrom_peak_snr) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <param name="param_algorithm_common_chrom_fwhm" type="float" value="5.0" label="Expected chromatographic peak width (in seconds)" help="(-chrom_fwhm) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <param name="param_algorithm_mtd_mass_error_ppm" type="float" value="20.0" label="Allowed mass deviation (in ppm)" help="(-mass_error_ppm) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <param name="param_algorithm_mtd_reestimate_mt_sd" type="boolean" truevalue="-algorithm:mtd:reestimate_mt_sd" falsevalue="" checked="true" optional="True" label="Enables dynamic re-estimation of m/z variance during mass trace collection stage" help="(-reestimate_mt_sd) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <param name="param_algorithm_epd_width_filtering" type="select" optional="True" value="fixed" label="Enable filtering of unlikely peak widths" help="(-width_filtering) 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">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <option value="off">off</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <option value="fixed">fixed</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <option value="auto">auto</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <param name="param_algorithm_epd_enabled" type="boolean" truevalue="-algorithm:epd:enabled" falsevalue="" checked="true" optional="True" label="Enables/disables the chromatographic peak detection of mass traces" help="(-enabled) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 <param name="param_force" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <param name="param_algorithm_mtd_trace_termination_criterion" type="select" optional="True" value="outlier" label="Termination criterion for the extension of mass traces" help="(-trace_termination_criterion) 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">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 <option value="outlier">outlier</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <option value="sample_rate">sample_rate</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 <param name="param_algorithm_mtd_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) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112 <param name="param_algorithm_mtd_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) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 <param name="param_algorithm_mtd_min_trace_length" type="float" value="5.0" label="Minimum expected length of a mass trace (in seconds)" help="(-min_trace_length) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114 <param name="param_algorithm_mtd_max_trace_length" type="float" value="300.0" label="Minimum expected length of a mass trace (in seconds)" help="(-max_trace_length) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
115 <param name="param_algorithm_epd_min_fwhm" type="float" value="3.0" label="Minimum full-width-at-half-maximum of chromatographic peaks (in seconds)" help="(-min_fwhm) Ignored if paramter width_filtering is off or auto"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116 <param name="param_algorithm_epd_max_fwhm" type="float" value="60.0" label="Maximum full-width-at-half-maximum of chromatographic peaks (in seconds)" help="(-max_fwhm) Ignored if paramter width_filtering is off or auto"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 <param name="param_algorithm_epd_masstrace_snr_filtering" type="boolean" truevalue="-algorithm:epd:masstrace_snr_filtering" falsevalue="" checked="false" optional="True" label="Apply post-filtering by signal-to-noise ratio after smoothing" help="(-masstrace_snr_filtering) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121 <data name="param_out" format="featurexml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
123 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
124
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
125 Detects mass traces in centroided LC-MS data.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
126
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
127
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
128 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_MassTraceExtractor.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
129 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
130 </tool>