annotate FeatureFinderIsotopeWavelet.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="FeatureFinderIsotopeWavelet" name="FeatureFinderIsotopeWavelet" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Detects two-dimensional features in LC-MS data.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">FeatureFinderIsotopeWavelet</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>FeatureFinderIsotopeWavelet
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_max_charge:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 -algorithm:max_charge $param_algorithm_max_charge
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #if $param_algorithm_intensity_threshold:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 -algorithm:intensity_threshold $param_algorithm_intensity_threshold
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #if $param_algorithm_hr_data:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 -algorithm:hr_data
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 #if $adv_opts.param_algorithm_intensity_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 -algorithm:intensity_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 #if " " in str($adv_opts.param_algorithm_intensity_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
35 "$adv_opts.param_algorithm_intensity_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
36 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
37 $adv_opts.param_algorithm_intensity_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
38 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 #if $adv_opts.param_algorithm_check_ppm:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 -algorithm:check_ppm
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 #if $adv_opts.param_algorithm_sweep_line_rt_votes_cutoff:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 -algorithm:sweep_line:rt_votes_cutoff $adv_opts.param_algorithm_sweep_line_rt_votes_cutoff
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 #if $adv_opts.param_algorithm_sweep_line_rt_interleave:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 -algorithm:sweep_line:rt_interleave $adv_opts.param_algorithm_sweep_line_rt_interleave
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 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 <param name="param_in" type="data" format="mzml" optional="False" label="input file" help="(-in) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 <param name="param_algorithm_max_charge" type="integer" min="1" optional="True" value="3" label="The maximal charge state to be considered" help="(-max_charge) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 <param name="param_algorithm_intensity_threshold" type="float" value="-1.0" label="The final threshold t' is build upon the formula: t' = av+t*sd, where t is the intensity_threshold, av the average intensity within the wavelet transformed signal and sd the standard deviation of the transform" help="(-intensity_threshold) If you set intensity_threshold=-1, t' will be zero. &lt;br&gt;As the 'optimal' value for this parameter is highly data dependent, we would recommend to start with -1, which will also extract features with very low signal-to-noise ratio. Subsequently, one might increase the threshold to find an optimized trade-off between false positives and true positives. Depending on the dynamic range of your spectra, suitable value ranges include: -1, [0:10], and if your data features even very high intensity values, t can also adopt values up to around 30. Please note that this parameter is not of an integer type, s.t. you can also use t:=0.1, e.g"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 <param name="param_algorithm_hr_data" type="boolean" truevalue="-algorithm:hr_data" falsevalue="" checked="false" optional="True" label="Must be true in case of high-resolution data, i.e. for spectra featuring large m/z-gaps (present in FTICR and Orbitrap data," help="(-hr_data) e.g.). Please check a single MS scan out of your recording, if you are unsure"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 <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
58 <param name="param_algorithm_intensity_type" type="select" optional="True" value="ref" label="Determines the intensity type returned for the identified features" help="(-intensity_type) 'ref' (default) returns the sum of the intensities of each isotopic peak within an isotope pattern. 'trans' refers to the intensity of the monoisotopic peak within the wavelet transform. 'corrected' refers also to the transformed intensity with an attempt to remove the effects of the convolution. While the latter ones might be preferable for qualitative analyses, 'ref' might be the best option to obtain quantitative results. Please note that intensity values might be spoiled (in particular for the option 'ref'), as soon as patterns overlap (see also the explanations given in the class documentation of FeatureFinderAlgorihtmIsotopeWavelet)">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 <option value="ref">ref</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 <option value="trans">trans</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 <option value="corrected">corrected</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 <param name="param_algorithm_check_ppm" type="boolean" truevalue="-algorithm:check_ppm" falsevalue="" checked="false" optional="True" label="Enables/disables a ppm test vs" help="(-check_ppm) the averagine model, i.e. potential peptide masses are checked for plausibility. In addition, a heuristic correcting potential mass shifts induced by the wavelet is applied"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 <param name="param_algorithm_sweep_line_rt_votes_cutoff" type="integer" min="0" optional="True" value="5" label="Defines the minimum number of subsequent scans where a pattern must occur to be considered as a feature" help="(-rt_votes_cutoff) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 <param name="param_algorithm_sweep_line_rt_interleave" type="integer" min="0" optional="True" value="1" label="Defines the maximum number of scans (w.r.t" help="(-rt_interleave) rt_votes_cutoff) where an expected pattern is missing. There is usually no reason to change the default value"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 <data name="param_out" format="featurexml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 Detects two-dimensional features in LC-MS data.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FeatureFinderIsotopeWavelet.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 </tool>