comparison FeatureFinderMetabo.xml @ 4:6ead64a594bd draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/openms commit 7a5239910fda9ed90cca286a38855703b40b1b56-dirty
author bgruening
date Wed, 27 Jan 2016 10:06:49 -0500
parents 3d84209d3178
children
comparison
equal deleted inserted replaced
3:ec62782f6c68 4:6ead64a594bd
1 <?xml version='1.0' encoding='UTF-8'?> 1 <?xml version="1.0" encoding="UTF-8"?>
2 <tool id="FeatureFinderMetabo" name="FeatureFinderMetabo" version="1.12.0"> 2 <!--This is a configuration file for the integration of a tools into Galaxy (https://galaxyproject.org/). This file was automatically generated using CTD2Galaxy.-->
3 <description>Assembles metabolite features from singleton mass traces.</description> 3 <!--Proposed Tool Section: [Quantitation]-->
4 <macros> 4 <tool id="FeatureFinderMetabo" name="FeatureFinderMetabo" version="2.0.0">
5 <token name="@EXECUTABLE@">FeatureFinderMetabo</token> 5 <description>Assembles metabolite features from singleton mass traces.</description>
6 <import>macros.xml</import> 6 <macros>
7 </macros> 7 <token name="@EXECUTABLE@">FeatureFinderMetabo</token>
8 <expand macro="stdio"/> 8 <import>macros.xml</import>
9 <expand macro="requirements"/> 9 </macros>
10 <command>FeatureFinderMetabo 10 <expand macro="references"/>
11 <expand macro="stdio"/>
12 <expand macro="requirements"/>
13 <command>FeatureFinderMetabo
11 14
12 -in ${param_in} 15 #if $param_in:
13 -out ${param_out} 16 -in $param_in
14 -threads \${GALAXY_SLOTS:-24} 17 #end if
15 -algorithm:common:noise_threshold_int ${param_noise_threshold_int} 18 #if $param_out:
16 -algorithm:common:chrom_peak_snr ${param_chrom_peak_snr} 19 -out $param_out
17 -algorithm:common:chrom_fwhm ${param_chrom_fwhm} 20 #end if
18 -algorithm:mtd:mass_error_ppm ${param_mass_error_ppm} 21 -threads \${GALAXY_SLOTS:-24}
19 ${param_reestimate_mt_sd} 22 #if $param_algorithm_common_noise_threshold_int:
20 ${param_enabled} 23 -algorithm:common:noise_threshold_int $param_algorithm_common_noise_threshold_int
21 -algorithm:epd:width_filtering ${param_width_filtering} 24 #end if
22 -algorithm:ffm:charge_lower_bound ${param_charge_lower_bound} 25 #if $param_algorithm_common_chrom_peak_snr:
23 -algorithm:ffm:charge_upper_bound ${param_charge_upper_bound} 26 -algorithm:common:chrom_peak_snr $param_algorithm_common_chrom_peak_snr
27 #end if
28 #if $param_algorithm_common_chrom_fwhm:
29 -algorithm:common:chrom_fwhm $param_algorithm_common_chrom_fwhm
30 #end if
31 #if $param_algorithm_mtd_mass_error_ppm:
32 -algorithm:mtd:mass_error_ppm $param_algorithm_mtd_mass_error_ppm
33 #end if
34 #if $param_algorithm_mtd_reestimate_mt_sd:
35 -algorithm:mtd:reestimate_mt_sd
36 #end if
37 #if $param_algorithm_epd_enabled:
38 -algorithm:epd:enabled
39 #end if
40 #if $param_algorithm_epd_width_filtering:
41 -algorithm:epd:width_filtering
42 #if &quot; &quot; in str($param_algorithm_epd_width_filtering):
43 &quot;$param_algorithm_epd_width_filtering&quot;
44 #else
45 $param_algorithm_epd_width_filtering
46 #end if
47 #end if
48 #if $param_algorithm_ffm_quant_method:
49 -algorithm:ffm:quant_method
50 #if &quot; &quot; in str($param_algorithm_ffm_quant_method):
51 &quot;$param_algorithm_ffm_quant_method&quot;
52 #else
53 $param_algorithm_ffm_quant_method
54 #end if
55 #end if
56 #if $param_algorithm_ffm_charge_lower_bound:
57 -algorithm:ffm:charge_lower_bound $param_algorithm_ffm_charge_lower_bound
58 #end if
59 #if $param_algorithm_ffm_charge_upper_bound:
60 -algorithm:ffm:charge_upper_bound $param_algorithm_ffm_charge_upper_bound
61 #end if
62 #if $param_algorithm_ffm_enable_RT_filtering:
63 -algorithm:ffm:enable_RT_filtering
64 #end if
24 #if $adv_opts.adv_opts_selector=='advanced': 65 #if $adv_opts.adv_opts_selector=='advanced':
25 -algorithm:mtd:trace_termination_criterion ${adv_opts.param_trace_termination_criterion} 66 #if $adv_opts.param_force:
26 -algorithm:mtd:trace_termination_outliers ${adv_opts.param_trace_termination_outliers} 67 -force
27 -algorithm:mtd:min_sample_rate ${adv_opts.param_min_sample_rate} 68 #end if
28 -algorithm:mtd:min_trace_length ${adv_opts.param_min_trace_length} 69 #if $adv_opts.param_algorithm_mtd_trace_termination_criterion:
29 -algorithm:mtd:max_trace_length ${adv_opts.param_max_trace_length} 70 -algorithm:mtd:trace_termination_criterion
30 -algorithm:epd:min_fwhm ${adv_opts.param_min_fwhm} 71 #if &quot; &quot; in str($adv_opts.param_algorithm_mtd_trace_termination_criterion):
31 -algorithm:epd:max_fwhm ${adv_opts.param_max_fwhm} 72 &quot;$adv_opts.param_algorithm_mtd_trace_termination_criterion&quot;
32 ${adv_opts.param_masstrace_snr_filtering} 73 #else
33 -algorithm:ffm:local_rt_range ${adv_opts.param_local_rt_range} 74 $adv_opts.param_algorithm_mtd_trace_termination_criterion
34 -algorithm:ffm:local_mz_range ${adv_opts.param_local_mz_range} 75 #end if
35 ${adv_opts.param_report_summed_ints} 76 #end if
36 ${adv_opts.param_disable_isotope_filtering} 77 #if $adv_opts.param_algorithm_mtd_trace_termination_outliers:
37 -algorithm:ffm:isotope_model ${adv_opts.param_isotope_model} 78 -algorithm:mtd:trace_termination_outliers $adv_opts.param_algorithm_mtd_trace_termination_outliers
38 -algorithm:ffm:isotope_noisemodel ${adv_opts.param_isotope_noisemodel} 79 #end if
39 ${adv_opts.param_use_smoothed_intensities} 80 #if $adv_opts.param_algorithm_mtd_min_sample_rate:
81 -algorithm:mtd:min_sample_rate $adv_opts.param_algorithm_mtd_min_sample_rate
82 #end if
83 #if $adv_opts.param_algorithm_mtd_min_trace_length:
84 -algorithm:mtd:min_trace_length $adv_opts.param_algorithm_mtd_min_trace_length
85 #end if
86 #if $adv_opts.param_algorithm_mtd_max_trace_length:
87 -algorithm:mtd:max_trace_length $adv_opts.param_algorithm_mtd_max_trace_length
88 #end if
89 #if $adv_opts.param_algorithm_epd_min_fwhm:
90 -algorithm:epd:min_fwhm $adv_opts.param_algorithm_epd_min_fwhm
91 #end if
92 #if $adv_opts.param_algorithm_epd_max_fwhm:
93 -algorithm:epd:max_fwhm $adv_opts.param_algorithm_epd_max_fwhm
94 #end if
95 #if $adv_opts.param_algorithm_epd_masstrace_snr_filtering:
96 -algorithm:epd:masstrace_snr_filtering
97 #end if
98 #if $adv_opts.param_algorithm_ffm_local_rt_range:
99 -algorithm:ffm:local_rt_range $adv_opts.param_algorithm_ffm_local_rt_range
100 #end if
101 #if $adv_opts.param_algorithm_ffm_local_mz_range:
102 -algorithm:ffm:local_mz_range $adv_opts.param_algorithm_ffm_local_mz_range
103 #end if
104 #if $adv_opts.param_algorithm_ffm_report_summed_ints:
105 -algorithm:ffm:report_summed_ints
106 #end if
107 #if $adv_opts.param_algorithm_ffm_disable_isotope_filtering:
108 -algorithm:ffm:disable_isotope_filtering
109 #end if
110 #if $adv_opts.param_algorithm_ffm_isotope_model:
111 -algorithm:ffm:isotope_model
112 #if &quot; &quot; in str($adv_opts.param_algorithm_ffm_isotope_model):
113 &quot;$adv_opts.param_algorithm_ffm_isotope_model&quot;
114 #else
115 $adv_opts.param_algorithm_ffm_isotope_model
116 #end if
117 #end if
118 #if $adv_opts.param_algorithm_ffm_isotope_noisemodel:
119 -algorithm:ffm:isotope_noisemodel
120 #if &quot; &quot; in str($adv_opts.param_algorithm_ffm_isotope_noisemodel):
121 &quot;$adv_opts.param_algorithm_ffm_isotope_noisemodel&quot;
122 #else
123 $adv_opts.param_algorithm_ffm_isotope_noisemodel
124 #end if
125 #end if
126 #if $adv_opts.param_algorithm_ffm_use_smoothed_intensities:
127 -algorithm:ffm:use_smoothed_intensities
128 #end if
40 #end if 129 #end if
41 </command> 130 </command>
42 <inputs> 131 <inputs>
43 <param name="param_in" type="data" format="mzML" optional="False" label="input centroided mzML file" help="(-in)"/> 132 <param format="mzml" help="(-in) " label="Centroided mzML file" name="param_in" optional="False" type="data"/>
44 <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)"/> 133 <param help="(-noise_threshold_int) " label="Intensity threshold below which peaks are regarded as noise" name="param_algorithm_common_noise_threshold_int" type="float" value="10.0"/>
45 <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)"/> 134 <param help="(-chrom_peak_snr) " label="Minimum signal-to-noise a mass trace should have" name="param_algorithm_common_chrom_peak_snr" type="float" value="3.0"/>
46 <param name="param_chrom_fwhm" type="float" value="5.0" label="Expected chromatographic peak width (in seconds)." help="(-chrom_fwhm)"/> 135 <param help="(-chrom_fwhm) " label="Expected chromatographic peak width (in seconds)" name="param_algorithm_common_chrom_fwhm" type="float" value="5.0"/>
47 <param name="param_mass_error_ppm" type="float" value="20.0" label="Allowed mass deviation (in ppm)." help="(-mass_error_ppm)"/> 136 <param help="(-mass_error_ppm) " label="Allowed mass deviation (in ppm)" name="param_algorithm_mtd_mass_error_ppm" type="float" value="20.0"/>
48 <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)"/> 137 <param checked="true" falsevalue="" help="(-reestimate_mt_sd) " label="Enables dynamic re-estimation of m/z variance during mass trace collection stage" name="param_algorithm_mtd_reestimate_mt_sd" optional="True" truevalue="-algorithm:mtd:reestimate_mt_sd" type="boolean"/>
49 <param name="param_enabled" type="boolean" truevalue="-algorithm:epd:enabled true" falsevalue="-algorithm:epd:enabled false" checked="true" optional="True" label="Enable splitting of isobaric mass traces by chromatographic peak detection. Disable for direct injection." help="(-enabled)"/> 138 <param checked="true" falsevalue="" help="(-enabled) Disable for direct injection" label="Enable splitting of isobaric mass traces by chromatographic peak detection" name="param_algorithm_epd_enabled" optional="True" truevalue="-algorithm:epd:enabled" type="boolean"/>
50 <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)"> 139 <param 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" label="Enable filtering of unlikely peak widths" name="param_algorithm_epd_width_filtering" optional="True" type="select" value="fixed">
51 <option value="off">off</option> 140 <option value="off">off</option>
52 <option value="fixed">fixed</option> 141 <option value="fixed">fixed</option>
53 <option value="auto">auto</option> 142 <option value="auto">auto</option>
54 </param>
55 <param name="param_charge_lower_bound" type="integer" value="1" label="Lowest charge state to consider" help="(-charge_lower_bound)"/>
56 <param name="param_charge_upper_bound" type="integer" value="3" label="Highest charge state to consider" help="(-charge_upper_bound)"/>
57 <expand macro="advanced_options">
58 <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)">
59 <option value="outlier">outlier</option>
60 <option value="sample_rate">sample_rate</option>
61 </param> 143 </param>
62 <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)"/> 144 <param help="(-quant_method) For LC data 'area' is recommended, 'median' for direct injection data" label="Method of quantification for mass traces" name="param_algorithm_ffm_quant_method" optional="True" type="select" value="area">
63 <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)"/> 145 <option value="area">area</option>
64 <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)"/> 146 <option value="median">median</option>
65 <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)"/>
66 <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)"/>
67 <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)"/>
68 <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)"/>
69 <param name="param_local_rt_range" type="float" value="10.0" label="RT range where to look for coeluting mass traces" help="(-local_rt_range)"/>
70 <param name="param_local_mz_range" type="float" value="6.5" label="MZ range where to look for isotopic mass traces" help="(-local_mz_range)"/>
71 <param name="param_report_summed_ints" type="boolean" truevalue="-algorithm:ffm:report_summed_ints true" falsevalue="-algorithm:ffm:report_summed_ints false" checked="false" optional="True" label="Set to true for a feature intensity summed up over all traces rather than using monoisotopic trace intensity alone." help="(-report_summed_ints)"/>
72 <param name="param_disable_isotope_filtering" type="boolean" truevalue="-algorithm:ffm:disable_isotope_filtering true" falsevalue="-algorithm:ffm:disable_isotope_filtering false" checked="false" optional="True" label="Disable isotope filtering." help="(-disable_isotope_filtering)"/>
73 <param name="param_isotope_model" type="select" optional="True" value="metabolites" label="Change type of isotope model." help="(-isotope_model)">
74 <option value="metabolites">metabolites</option>
75 <option value="peptides">peptides</option>
76 </param> 147 </param>
77 <param name="param_isotope_noisemodel" type="select" optional="True" value="5%RMS" label="SVM isotope models were trained with either 2% or 5% RMS error. Select the appropriate noise model according to the quality of measurement or MS device." help="(-isotope_noisemodel)"> 148 <param help="(-charge_lower_bound) " label="Lowest charge state to conside" name="param_algorithm_ffm_charge_lower_bound" type="integer" value="1"/>
78 <option value="5%RMS">5%RMS</option> 149 <param help="(-charge_upper_bound) " label="Highest charge state to conside" name="param_algorithm_ffm_charge_upper_bound" type="integer" value="3"/>
79 <option value="2%RMS">2%RMS</option> 150 <param checked="true" falsevalue="" help="(-enable_RT_filtering) Disable for direct injection data" label="Require sufficient overlap in RT while assembling mass traces" name="param_algorithm_ffm_enable_RT_filtering" optional="True" truevalue="-algorithm:ffm:enable_RT_filtering" type="boolean"/>
80 </param> 151 <expand macro="advanced_options">
81 <param name="param_use_smoothed_intensities" type="boolean" truevalue="-algorithm:ffm:use_smoothed_intensities true" falsevalue="-algorithm:ffm:use_smoothed_intensities false" checked="true" optional="True" label="Use LOWESS intensities instead of raw intensities." help="(-use_smoothed_intensities)"/> 152 <param checked="false" falsevalue="" help="(-force) " label="Overwrite tool specific checks" name="param_force" optional="True" truevalue="-force" type="boolean"/>
82 </expand> 153 <param 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" label="Termination criterion for the extension of mass traces" name="param_algorithm_mtd_trace_termination_criterion" optional="True" type="select" value="outlier">
83 </inputs> 154 <option value="outlier">outlier</option>
84 <outputs> 155 <option value="sample_rate">sample_rate</option>
85 <data name="param_out" label="output featureXML file with metabolite features" format="featureXML"/> 156 </param>
86 </outputs> 157 <param help="(-trace_termination_outliers) " label="Mass trace extension in one direction cancels if this number of consecutive spectra with no detectable peaks is reached" name="param_algorithm_mtd_trace_termination_outliers" type="integer" value="5"/>
87 <help>**What it does** 158 <param help="(-min_sample_rate) " label="Minimum fraction of scans along the mass trace that must contain a peak" name="param_algorithm_mtd_min_sample_rate" type="float" value="0.5"/>
88 159 <param help="(-min_trace_length) " label="Minimum expected length of a mass trace (in seconds)" name="param_algorithm_mtd_min_trace_length" type="float" value="5.0"/>
89 Assembles metabolite features from singleton mass traces. 160 <param help="(-max_trace_length) " label="Maximum expected length of a mass trace (in seconds)" name="param_algorithm_mtd_max_trace_length" type="float" value="300.0"/>
161 <param help="(-min_fwhm) Ignored if parameter width_filtering is off or auto" label="Minimum full-width-at-half-maximum of chromatographic peaks (in seconds)" name="param_algorithm_epd_min_fwhm" type="float" value="3.0"/>
162 <param help="(-max_fwhm) Ignored if parameter width_filtering is off or auto" label="Maximum full-width-at-half-maximum of chromatographic peaks (in seconds)" name="param_algorithm_epd_max_fwhm" type="float" value="60.0"/>
163 <param checked="false" falsevalue="" help="(-masstrace_snr_filtering) " label="Apply post-filtering by signal-to-noise ratio after smoothing" name="param_algorithm_epd_masstrace_snr_filtering" optional="True" truevalue="-algorithm:epd:masstrace_snr_filtering" type="boolean"/>
164 <param help="(-local_rt_range) " label="RT range where to look for coeluting mass traces" name="param_algorithm_ffm_local_rt_range" type="float" value="10.0"/>
165 <param help="(-local_mz_range) " label="MZ range where to look for isotopic mass traces" name="param_algorithm_ffm_local_mz_range" type="float" value="6.5"/>
166 <param checked="false" falsevalue="" help="(-report_summed_ints) " label="Set to true for a feature intensity summed up over all traces rather than using monoisotopic trace intensity alone" name="param_algorithm_ffm_report_summed_ints" optional="True" truevalue="-algorithm:ffm:report_summed_ints" type="boolean"/>
167 <param checked="false" falsevalue="" help="(-disable_isotope_filtering) " label="Disable isotope filtering" name="param_algorithm_ffm_disable_isotope_filtering" optional="True" truevalue="-algorithm:ffm:disable_isotope_filtering" type="boolean"/>
168 <param help="(-isotope_model) " label="Change type of isotope model" name="param_algorithm_ffm_isotope_model" optional="True" type="select" value="metabolites">
169 <option value="metabolites">metabolites</option>
170 <option value="peptides">peptides</option>
171 </param>
172 <param help="(-isotope_noisemodel) Select the appropriate noise model according to the quality of measurement or MS device" label="SVM isotope models were trained with either 2% or 5% RMS erro" name="param_algorithm_ffm_isotope_noisemodel" optional="True" type="select" value="5%RMS">
173 <option value="5%RMS">5%RMS</option>
174 <option value="2%RMS">2%RMS</option>
175 </param>
176 <param checked="true" falsevalue="" help="(-use_smoothed_intensities) " label="Use LOWESS intensities instead of raw intensities" name="param_algorithm_ffm_use_smoothed_intensities" optional="True" truevalue="-algorithm:ffm:use_smoothed_intensities" type="boolean"/>
177 </expand>
178 </inputs>
179 <outputs>
180 <data format="xml" name="param_out"/>
181 </outputs>
182 <help>Assembles metabolite features from singleton mass traces.
90 183
91 184
92 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FeatureFinderMetabo.html 185 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FeatureFinderMetabo.html</help>
93 186 </tool>
94 @REFERENCES@
95 </help>
96 </tool>