annotate FeatureFinderIsotopeWavelet.xml @ 0:8b692fe8001b draft

planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
author galaxyp
date Wed, 01 Mar 2017 12:18:21 -0500
parents
children 6f98127fa81c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
2 <!--This is a configuration file for the integration of a tools into Galaxy (https://galaxyproject.org/). This file was automatically generated using CTD2Galaxy.-->
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
3 <!--Proposed Tool Section: [Quantitation]-->
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
4 <tool id="FeatureFinderIsotopeWavelet" name="FeatureFinderIsotopeWavelet" version="2.1.0">
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
5 <description>Detects two-dimensional features in LC-MS data.</description>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
6 <macros>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
7 <token name="@EXECUTABLE@">FeatureFinderIsotopeWavelet</token>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
8 <import>macros.xml</import>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
9 </macros>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
10 <expand macro="references"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
11 <expand macro="stdio"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
12 <expand macro="requirements"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
13 <command>FeatureFinderIsotopeWavelet
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
14
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
15 #if $param_in:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
16 -in $param_in
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
17 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
18 #if $param_out:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
19 -out $param_out
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
20 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
21 #if $param_algorithm_max_charge:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
22 -algorithm:max_charge $param_algorithm_max_charge
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
23 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
24 #if $param_algorithm_intensity_threshold:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
25 -algorithm:intensity_threshold $param_algorithm_intensity_threshold
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
26 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
27 #if $param_algorithm_hr_data:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
28 -algorithm:hr_data
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
29 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
30 #if $adv_opts.adv_opts_selector=='advanced':
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
31 #if $adv_opts.param_force:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
32 -force
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
33 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
34 #if $adv_opts.param_algorithm_intensity_type:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
35 -algorithm:intensity_type $adv_opts.param_algorithm_intensity_type
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
36 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
37 #if $adv_opts.param_algorithm_check_ppm:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
38 -algorithm:check_ppm
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
39 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
40 #if $adv_opts.param_algorithm_sweep_line_rt_votes_cutoff:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
41 -algorithm:sweep_line:rt_votes_cutoff $adv_opts.param_algorithm_sweep_line_rt_votes_cutoff
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
42 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
43 #if $adv_opts.param_algorithm_sweep_line_rt_interleave:
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
44 -algorithm:sweep_line:rt_interleave $adv_opts.param_algorithm_sweep_line_rt_interleave
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
45 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
46 #end if
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
47 </command>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
48 <inputs>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
49 <param name="param_in" type="data" format="mzml" optional="False" label="input file" help="(-in) "/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
50 <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) "/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
51 <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"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
52 <param name="param_algorithm_hr_data" display="radio" 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"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
53 <expand macro="advanced_options">
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
54 <param name="param_force" display="radio" type="boolean" truevalue="-force" falsevalue="" checked="false" optional="True" label="Overwrite tool specific checks" help="(-force) "/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
55 <param name="param_algorithm_intensity_type" display="radio" type="select" optional="False" 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)">
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
56 <option value="ref" selected="true">ref</option>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
57 <option value="trans">trans</option>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
58 <option value="corrected">corrected</option>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
59 </param>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
60 <param name="param_algorithm_check_ppm" display="radio" 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"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
61 <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) "/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
62 <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"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
63 </expand>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
64 </inputs>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
65 <outputs>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
66 <data name="param_out" format="featurexml"/>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
67 </outputs>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
68 <help>Detects two-dimensional features in LC-MS data.
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
69
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
70
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
71 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_FeatureFinderIsotopeWavelet.html</help>
8b692fe8001b planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit fb85d488133bb2b5f483b52b2db0ac66038fafb8
galaxyp
parents:
diff changeset
72 </tool>