annotate SpectraMerger.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="SpectraMerger" name="SpectraMerger" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Merges spectra (each MS level separately), increasing S/N ratios.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">SpectraMerger</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>SpectraMerger
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_merging_method:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 -merging_method
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #if " " in str($param_merging_method):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 "$param_merging_method"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 $param_merging_method
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
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if $rep_param_algorithm_block_method_ms_levels:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 -algorithm:block_method:ms_levels
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #for token in $rep_param_algorithm_block_method_ms_levels:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #if " " in str(token):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 "$token.param_algorithm_block_method_ms_levels"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 $token.param_algorithm_block_method_ms_levels
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #end for
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #if $param_algorithm_block_method_rt_block_size:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 -algorithm:block_method:rt_block_size $param_algorithm_block_method_rt_block_size
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #if $param_algorithm_block_method_rt_max_length:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 -algorithm:block_method:rt_max_length $param_algorithm_block_method_rt_max_length
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #if $param_algorithm_precursor_method_mz_tolerance:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 -algorithm:precursor_method:mz_tolerance $param_algorithm_precursor_method_mz_tolerance
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #if $param_algorithm_precursor_method_rt_tolerance:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 -algorithm:precursor_method:rt_tolerance $param_algorithm_precursor_method_rt_tolerance
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #if $adv_opts.adv_opts_selector=='advanced':
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_mz_binning_width:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -algorithm:mz_binning_width $adv_opts.param_algorithm_mz_binning_width
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $adv_opts.param_algorithm_mz_binning_width_unit:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -algorithm:mz_binning_width_unit
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #if " " in str($adv_opts.param_algorithm_mz_binning_width_unit):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 "$adv_opts.param_algorithm_mz_binning_width_unit"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 $adv_opts.param_algorithm_mz_binning_width_unit
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_sort_blocks:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 -algorithm:sort_blocks
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #if " " in str($adv_opts.param_algorithm_sort_blocks):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 "$adv_opts.param_algorithm_sort_blocks"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 $adv_opts.param_algorithm_sort_blocks
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 <param name="param_in" type="data" format="mzml" optional="False" label="Input mzML file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 <param name="param_merging_method" type="select" optional="True" value="block_method" label="Method of merging which should be used" help="(-merging_method) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 <option value="precursor_method">precursor_method</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 <option value="block_method">block_method</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 <repeat name="rep_param_algorithm_block_method_ms_levels" min="0" max="1" title="param_algorithm_block_method_ms_levels">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 <param name="param_algorithm_block_method_ms_levels" type="text" min="1" optional="True" size="30" value="1" label="Merge spectra of this level" help="(-ms_levels) All spectra with other MS levels remain untouched">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 </repeat>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 <param name="param_algorithm_block_method_rt_block_size" type="integer" min="1" optional="True" value="5" label="Maximum number of scans to be summed up" help="(-rt_block_size) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 <param name="param_algorithm_block_method_rt_max_length" type="float" min="0.0" max="1e+11" optional="True" value="0.0" label="Maximum RT size of the block in seconds (0.0 = no size restriction)" help="(-rt_max_length) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 <param name="param_algorithm_precursor_method_mz_tolerance" type="float" min="0.0" optional="True" value="0.0001" label="Max m/z distance of the precursor entries of two spectra to be merged in [Da]" help="(-mz_tolerance) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 <param name="param_algorithm_precursor_method_rt_tolerance" type="float" min="0.0" optional="True" value="5.0" label="Max RT distance of the precursor entries of two spectra to be merged in [s]" help="(-rt_tolerance) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 <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
97 <param name="param_algorithm_mz_binning_width" type="float" min="0.0" optional="True" value="0.0001" label="Max m/z distance of two peaks to be merged" help="(-mz_binning_width) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 <param name="param_algorithm_mz_binning_width_unit" type="select" optional="True" value="Da" label="Unit in which the distance between two peaks is given" help="(-mz_binning_width_unit) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 <option value="Da">Da</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 <option value="ppm">ppm</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <param name="param_algorithm_sort_blocks" type="select" optional="True" value="RT_ascending" label="Sort blocks by &lt;?&gt; before merging them (useful for precursor order)" help="(-sort_blocks) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <option value="RT_ascending">RT_ascending</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 <option value=" RT_descending"> RT_descending</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <data name="param_out" format="mzml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 Merges spectra (each MS level separately), increasing S/N ratios.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
115
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_SpectraMerger.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 </tool>