annotate PeakPickerHiRes.xml @ 1:e37e8ba1b4b7 draft

Uploaded
author bgruening
date Thu, 16 Apr 2015 09:01:52 -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="PeakPickerHiRes" name="PeakPickerHiRes" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Finds mass spectrometric peaks in profile mass spectra.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">PeakPickerHiRes</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>PeakPickerHiRes
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 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 #if $param_algorithm_signal_to_noise:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 -algorithm:signal_to_noise $param_algorithm_signal_to_noise
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 #if $rep_param_algorithm_ms_levels:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 -algorithm:ms_levels
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #for token in $rep_param_algorithm_ms_levels:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #if " " in str(token):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 "$token.param_algorithm_ms_levels"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 $token.param_algorithm_ms_levels
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #end for
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #if $param_algorithm_SignalToNoise_win_len:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 -algorithm:SignalToNoise:win_len $param_algorithm_SignalToNoise_win_len
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #if $param_algorithm_SignalToNoise_bin_count:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 -algorithm:SignalToNoise:bin_count $param_algorithm_SignalToNoise_bin_count
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $param_algorithm_SignalToNoise_min_required_elements:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -algorithm:SignalToNoise:min_required_elements $param_algorithm_SignalToNoise_min_required_elements
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #if $adv_opts.param_processOption:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 -processOption
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if " " in str($adv_opts.param_processOption):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 "$adv_opts.param_processOption"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 $adv_opts.param_processOption
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if $adv_opts.param_algorithm_spacing_difference_gap:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -algorithm:spacing_difference_gap $adv_opts.param_algorithm_spacing_difference_gap
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $adv_opts.param_algorithm_spacing_difference:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -algorithm:spacing_difference $adv_opts.param_algorithm_spacing_difference
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #if $adv_opts.param_algorithm_missing:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 -algorithm:missing $adv_opts.param_algorithm_missing
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #if $adv_opts.param_algorithm_SignalToNoise_max_intensity:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 -algorithm:SignalToNoise:max_intensity $adv_opts.param_algorithm_SignalToNoise_max_intensity
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 #if $adv_opts.param_algorithm_SignalToNoise_auto_max_stdev_factor:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 -algorithm:SignalToNoise:auto_max_stdev_factor $adv_opts.param_algorithm_SignalToNoise_auto_max_stdev_factor
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 #if $adv_opts.param_algorithm_SignalToNoise_auto_max_percentile:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 -algorithm:SignalToNoise:auto_max_percentile $adv_opts.param_algorithm_SignalToNoise_auto_max_percentile
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 #if $adv_opts.param_algorithm_SignalToNoise_auto_mode:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 -algorithm:SignalToNoise:auto_mode $adv_opts.param_algorithm_SignalToNoise_auto_mode
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 #if $adv_opts.param_algorithm_SignalToNoise_noise_for_empty_window:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 -algorithm:SignalToNoise:noise_for_empty_window $adv_opts.param_algorithm_SignalToNoise_noise_for_empty_window
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <param name="param_in" type="data" format="mzml" optional="False" label="input profile data file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <param name="param_algorithm_signal_to_noise" type="float" min="0.0" optional="True" value="1.0" label="Minimal signal-to-noise ratio for a peak to be picked (0.0 disables SNT estimation!)" help="(-signal_to_noise) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 <repeat name="rep_param_algorithm_ms_levels" min="0" max="1" title="param_algorithm_ms_levels">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <param name="param_algorithm_ms_levels" type="text" min="1" optional="True" size="30" value="1 2" label="List of MS levels for which the peak picking is applied" help="(-ms_levels) Other scans are copied to the output without changes">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 </repeat>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <param name="param_algorithm_SignalToNoise_win_len" type="float" min="1.0" optional="True" value="200.0" label="window length in Thomson" help="(-win_len) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <param name="param_algorithm_SignalToNoise_bin_count" type="integer" min="3" optional="True" value="30" label="number of bins for intensity values" help="(-bin_count) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <param name="param_algorithm_SignalToNoise_min_required_elements" type="integer" min="1" optional="True" value="10" label="minimum number of elements required in a window (otherwise it is considered sparse)" help="(-min_required_elements) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 <param name="param_processOption" type="select" optional="True" value="inmemory" label="Whether to load all data and process them in-memory or whether to process the data on the fly (lowmemory) without loading the whole file into memory first" help="(-processOption) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <option value="inmemory">inmemory</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <option value="lowmemory">lowmemory</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 <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
102 <param name="param_algorithm_spacing_difference_gap" type="float" min="0.0" optional="True" value="4.0" label="The extension of a peak is stopped if the spacing between two subsequent data points exceeds 'spacing_difference_gap * min_spacing'" help="(-spacing_difference_gap) 'min_spacing' is the smaller of the two spacings from the peak apex to its two neighboring points. '0' to disable the constraint. Not applicable to chromatograms"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <param name="param_algorithm_spacing_difference" type="float" min="0.0" optional="True" value="1.5" label="Maximum allowed difference between points during peak extension, in multiples of the minimal difference between the peak apex and its two neighboring points" help="(-spacing_difference) If this difference is exceeded a missing point is assumed (see parameter 'missing'). A higher value implies a less stringent peak definition, since individual signals within the peak are allowed to be further apart. '0' to disable the constraint. Not applicable to chromatograms"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <param name="param_algorithm_missing" type="integer" min="0" optional="True" value="1" label="Maximum number of missing points allowed when extending a peak to the left or to the right" help="(-missing) A missing data point occurs if the spacing between two subsequent data points exceeds 'spacing_difference * min_spacing'. 'min_spacing' is the smaller of the two spacings from the peak apex to its two neighboring points. Not applicable to chromatograms"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 <param name="param_algorithm_SignalToNoise_max_intensity" type="integer" min="-1" optional="True" value="-1" label="maximal intensity considered for histogram construction" help="(-max_intensity) By default, it will be calculated automatically (see auto_mode). Only provide this parameter if you know what you are doing (and change 'auto_mode' to '-1')! All intensities EQUAL/ABOVE 'max_intensity' will be added to the LAST histogram bin. If you choose 'max_intensity' too small, the noise estimate might be too small as well. If chosen too big, the bins become quite large (which you could counter by increasing 'bin_count', which increases runtime). In general, the Median-S/N estimator is more robust to a manual max_intensity than the MeanIterative-S/N"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 <param name="param_algorithm_SignalToNoise_auto_max_stdev_factor" type="float" min="0.0" max="999.0" optional="True" value="3.0" label="parameter for 'max_intensity' estimation (if 'auto_mode' == 0): mean + 'auto_max_stdev_factor' * stdev" help="(-auto_max_stdev_factor) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <param name="param_algorithm_SignalToNoise_auto_max_percentile" type="integer" min="0" max="100" optional="True" value="95" label="parameter for 'max_intensity' estimation (if 'auto_mode' == 1): auto_max_percentile th percentile" help="(-auto_max_percentile) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 <param name="param_algorithm_SignalToNoise_auto_mode" type="integer" min="-1" max="1" optional="True" value="0" label="method to use to determine maximal intensity: -1 --&gt; use 'max_intensity'; 0 --&gt; 'auto_max_stdev_factor' method (default); 1 --&gt; 'auto_max_percentile' method" help="(-auto_mode) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <param name="param_algorithm_SignalToNoise_noise_for_empty_window" type="float" value="1e+20" label="noise value used for sparse windows" help="(-noise_for_empty_window) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 <data name="param_out" format="mzml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
115 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 Finds mass spectrometric peaks in profile mass spectra.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_PeakPickerHiRes.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122 </tool>