annotate peak_list_preprocessor.xml @ 5:9816d9abb501 draft

Added repo dependencies
author galaxyp
date Thu, 20 Jun 2013 16:12:09 -0400
parents cf0d72c7b482
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
1 <tool id="openms_peak_list_preprocessor" version="0.1" name="Peak List Preprocessor">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
2 <description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
3 Wizard to apply multiple OpenMS signal preprocessing tools for peak lists.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
4 </description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
5 <macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
6 <import>macros.xml</import>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
7 </macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
8 <expand macro="stdio" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
9 <expand macro="requires" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
10 <configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
11 <configfile name="setup_input">cp '$input' 'output.mzML'</configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
12 <configfile name="rename">mv 'output.mzML' 'input.mzML'</configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
13 <configfile name="copy_output">mv 'output.mzML' '$output'</configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
14 <configfile name="resampler_config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
15 #if $resample.do
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
16 in=input.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
17 out=output.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
18 sampling_rate=$resample.sampling_rate
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
19 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
20 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
21 <configfile name="noise_filter_config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
22 #set $noise_filter_type = str($noise.type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
23 in=input.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
24 out=output.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
25 #if $noise_filter_type == 'NoiseFilterGaussian'
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
26
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
27 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
28 #if $noise_filter_type == 'NoiseFilterSGolay'
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
29
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
30 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
31 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
32 <configfile name="baseline_config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
33 in=input.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
34 out=output.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
35 #if $baseline.do
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
36
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
37 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
38 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
39 <configfile name="peak_picker_config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
40 #set $peak_picker_type = str($peak_picker.type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
41 in=input.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
42 out=output.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
43 #if $peak_picker_type == 'PeakPickerHiRes'
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
44 algorithm!signal_to_noise=$peak_picker.signal_to_noise
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
45 algorithm!ms1_only=$peak_picker.ms1_only
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
46 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
47 #if $peak_picker_type == 'PeakPickerWavelet'
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
48 algorithm!signal_to_noise=$peak_picker.signal_to_noise
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
49 #if $peak_picker.peak_width.estimate
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
50 algorithm!estimate_peak_width=true
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
51 #else
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
52 algorithm!estimate_peak_width=false
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
53 algorithm!peak_width=$peak_picker.peak_width.peak_width
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
54 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
55 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
56 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
57 <configfile name="mass_corrector_config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
58 in=input.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
59 out=output.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
60 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
61 <configfile name="spectra_filter_config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
62 in=input.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
63 out=output.mzML
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
64 #set $spectra_filter_type = str($spectra_filter.type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
65 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
66 </configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
67 <command interpreter="python">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
68 openms_wrapper.py
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
69 --executable '__SHELL__' --config $setup_input
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
70 #if $resample.do
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
71 --executable '__SHELL__' --config $rename
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
72 --executable 'Resampler' --config $resampler_config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
73 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
74 #set $noise_filter_type = str($noise.type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
75 #if $noise_filter_type != "none"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
76 --executable '__SHELL__' --config $rename
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
77 --executable '$noise_filter_type' --config $noise_filter_config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
78 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
79 #if $baseline.do
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
80 --executable '__SHELL__' --config $rename
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
81 --executable 'BaselineFilter' --config $baseline_config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
82 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
83 #set $peak_picker_type = str($peak_picker.type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
84 #if $peak_picker_type != "none"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
85 --executable '__SHELL__' --config $rename
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
86 --executable '$peak_picker_type' --config $peak_picker_config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
87 #if $peak_picker_type == "PeakPickerHiRes"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
88 #if $peak_picker.use_high_res_mass_corrector
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
89 --executable '__SHELL__' --config $rename
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
90 --executable 'HighResPrecursorMassCorrector' --config $mass_corrector_config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
91 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
92 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
93 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
94 #set $spectra_filter_type = str($spectra_filter.type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
95 #if $spectra_filter_type != "none"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
96 --executable '__SHELL__' --config $rename
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
97 --executable '$spectra_filter_type' --config $spectra_filter_config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
98 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
99 --executable '__SHELL__' --config $copy_output
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
100 </command>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
101 <inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
102 <!-- TODO: Maybe even have a conversion step here. -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
103 <param format="mzML" name="input" type="data" label="Input Peak List (mzML)"/>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
104 <conditional name="resample">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
105 <param name="do" type="boolean" label="Resample" help="If you want to use the Savitzky Golay filter, or Baseline filter with non equally spaced profile data, e.g. TOF data, you have should generate equally spaced data by resampling.">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
106 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
107 <when value="false">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
108 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
109 <when value="true">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
110 <expand macro="sampling_rate_param" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
111 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
112 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
113 <conditional name="noise">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
114 <param name="type" type="select" label="Noise Filter" help="">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
115 <option value="none" select="true">None</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
116 <option value="NoiseFilterGaussian">Gaussian</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
117 <option value="NoiseFilterSGolay">Savitzky Golay</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
118 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
119 <when value="none">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
120 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
121 <when value="NoiseFilterGaussian">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
122 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
123 <when value="NoiseFilterSGolay">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
124 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
125 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
126 <conditional name="baseline">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
127 <param name="do" type="boolean" label="Apply Baseline Filter" help="Executes the top-hat filter to remove the baseline of an MS experiment." />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
128 <when value="false">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
129 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
130 <when value="true">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
131 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
132 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
133 <conditional name="peak_picker">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
134 <param name="type" type="select" label="Peak Picker" help="">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
135 <option value="none" select="true">None</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
136 <option value="PeakPickerHiRes">High Resolution</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
137 <option value="PeakPickerWavelet">Wavelet</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
138 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
139 <when value="none">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
140 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
141 <when value="PeakPickerHiRes">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
142 <param name="signal_to_noise" label="Signal-to-noise Ratio" help="Minimal signal to noise ratio for a peak to be picked. (0.0 disables SNT estimation!)" value="1.0" type="float" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
143 <param name="ms1_only" type="boolean" label="MS1 Only" truevalue="true" falsevalue="false" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
144 <param name="use_high_res_mass_corrector" label="Correct precursor m/z on centroided high resolution data." checked="false" type="boolean" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
145 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
146 <when value="PeakPickerWavelet">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
147 <param name="signal_to_noise" label="Signal-to-noise Ratio" help="Minimal signal to noise ratio for a peak to be picked." value="1.0" type="float" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
148 <conditional name="peak_width">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
149 <param name="estimate" label="Estimate Peak Width" type="boolean" checked="false" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
150 <when value="true">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
151 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
152 <when value="false">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
153 <param name="peak_width" type="float" value="0.15" help="Approximate fwhm of the peaks." label="Peak Width" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
154 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
155 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
156 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
157 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
158 <conditional name="spectra_filter">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
159 <param name="type" type="select" label="Apply Spectra Filter" help="">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
160 <option value="none" select="true">None</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
161 <option value="SpectraFilterNLargest">N Largest</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
162 <option value="SpectraFilterNormalizer">Normalizer</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
163 <option value="SpectraFilterScaler">Scaler</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
164 <option value="SpectraFilterBernNorm">Bern et. al. normalization</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
165 <option value="SpectraFilterMarkerMower">Marker Mower</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
166 <option value="SpectraFilterParentPeakMower">Parent Peak Mower</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
167 <option value="SpectraFilterSqrtMower">Square Root Mower</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
168 <option value="SpectraFilterThresholdMower">Threshold Mower</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
169 <option value="SpectraFilterWindowMower">Window Mower</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
170 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
171 <when value="none">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
172 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
173 <when value="SpectraFilterNLargest">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
174 <!-- 1 param -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
175 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
176 <when value="SpectraFilterNormalizer">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
177 <!-- 1 param -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
178 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
179 <when value="SpectraFilterScaler">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
180 <!-- 3 params -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
181 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
182 <when value="SpectraFilterBernNorm">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
183 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
184 <when value="SpectraFilterMarkerMower">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
185 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
186 <when value="SpectraFilterParentPeakMower">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
187 <!-- Tons of params -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
188 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
189 <when value="SpectraFilterSqrtMower">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
190 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
191 <when value="SpectraFilterThresholdMower">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
192 <!-- 1 param -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
193 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
194 <when value="SpectraFilterWindowMower">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
195 <!-- 2 params -->
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
196 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
197 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
198 </inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
199 <outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
200 <data format="mzml" name="output" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
201 </outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
202 <help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
203 **What it does**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
204
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
205 **Citation**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
206
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
207 For the underlying tool, please cite ``Marc Sturm, Andreas Bertsch, Clemens Gröpl, Andreas Hildebrandt, Rene Hussong, Eva Lange, Nico Pfeifer, Ole Schulz-Trieglaff, Alexandra Zerck, Knut Reinert, and Oliver Kohlbacher, 2008. OpenMS – an Open-Source Software Framework for Mass Spectrometry. BMC Bioinformatics 9: 163. doi:10.1186/1471-2105-9-163.``
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
208
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
209 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
210 </help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
211 </tool>