annotate MapAlignerSpectrum.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="MapAlignerSpectrum" name="MapAlignerSpectrum" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Corrects retention time distortions between maps by spectrum alignment.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">MapAlignerSpectrum</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>MapAlignerSpectrum
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
11
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
12 -in
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
13 #for token in $param_in:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
14 $token
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
15 #end for
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
16
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
17 #if $rep_param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
18 -out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
19 #for token in $rep_param_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
20 #if " " in str(token):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
21 "$token.param_out"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
22 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
23 $token.param_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
24 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
25 #end for
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
26 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
27
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
28 #if $rep_param_trafo_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
29 -trafo_out
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
30 #for token in $rep_param_trafo_out:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
31 #if " " in str(token):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
32 "$token.param_trafo_out"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
33 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
34 $token.param_trafo_out
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 -threads \${GALAXY_SLOTS:-24}
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
39 #if $param_algorithm_gapcost:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -algorithm:gapcost $param_algorithm_gapcost
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_algorithm_affinegapcost:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -algorithm:affinegapcost $param_algorithm_affinegapcost
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_algorithm_scorefunction:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -algorithm:scorefunction
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #if " " in str($param_algorithm_scorefunction):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 "$param_algorithm_scorefunction"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 $param_algorithm_scorefunction
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #if $param_model_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 -model:type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 #if " " in str($param_model_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 "$param_model_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 $param_model_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 #if $param_model_linear_symmetric_regression:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 -model:linear:symmetric_regression
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #if $param_model_b_spline_wavelength:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 -model:b_spline:wavelength $param_model_b_spline_wavelength
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #if $param_model_b_spline_num_nodes:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 -model:b_spline:num_nodes $param_model_b_spline_num_nodes
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 #if $param_model_b_spline_extrapolate:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 -model:b_spline:extrapolate
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 #if " " in str($param_model_b_spline_extrapolate):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 "$param_model_b_spline_extrapolate"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 $param_model_b_spline_extrapolate
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 #if $param_model_b_spline_boundary_condition:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 -model:b_spline:boundary_condition $param_model_b_spline_boundary_condition
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 #if $param_model_interpolated_interpolation_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 -model:interpolated:interpolation_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 #if " " in str($param_model_interpolated_interpolation_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 "$param_model_interpolated_interpolation_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 $param_model_interpolated_interpolation_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 #if $adv_opts.param_algorithm_cutoff_score:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 -algorithm:cutoff_score $adv_opts.param_algorithm_cutoff_score
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 #if $adv_opts.param_algorithm_bucketsize:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 -algorithm:bucketsize $adv_opts.param_algorithm_bucketsize
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 #if $adv_opts.param_algorithm_anchorpoints:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 -algorithm:anchorpoints $adv_opts.param_algorithm_anchorpoints
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 #if $adv_opts.param_algorithm_mismatchscore:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 -algorithm:mismatchscore $adv_opts.param_algorithm_mismatchscore
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
104 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 <param name="param_in" type="data" format="mzml" multiple="true" optional="False" size="30" label="Input files separated by blanks (all must have the same file type)" help="(-in) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
115 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116 <param name="param_algorithm_gapcost" type="float" min="0.0" optional="True" value="1.0" label=" This Parameter stands for the cost of opining a gap in the Alignment" help="(-gapcost) A Gap means that one Spectrum can not be aligned directly to another Spectrum in the Map. This happens, when the similarity of both spectra a too low or even not present. Imagen as a insert or delete of the spectrum in the map. The gap is necessary for aligning, if we open a gap there is a possibility that an another spectrum can be correct aligned with a higher score as before without gap. But to open a gap is a negative event and has to be punished a bit, so such only in case it 's a good choice to open a gap, if the score is bad enough. The Parameter is to giving as a positive number, the implementation convert it to a negative number"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 <param name="param_algorithm_affinegapcost" type="float" min="0.0" optional="True" value="0.5" label=" This Parameter controls the cost of extension a already open gap" help="(-affinegapcost) The idea behind the affine gapcost lies under the assumption, that it is better to get a long distance of connected gaps than to have a structure gap match gap match. There for the punishment for the extension of a gap has to be lower than the normal gapcost. If the the result of the alignment show high compression, it is a good idea to lower the affine gapcost or the normal gapcost"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 <param name="param_algorithm_scorefunction" type="select" optional="True" value="SteinScottImproveScore" label=" The score function is the core of an alignment" help="(-scorefunction) The success of an alignment depends mostly of the elected score function. The score function return the similarity of two Spectrum back. The score influence defines later the way of possible traceback. There exist many way of algorithm to calculate the score">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119 <option value="SteinScottImproveScore">SteinScottImproveScore</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120 <option value="ZhangSimilarityScore">ZhangSimilarityScore</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122 <param name="param_model_type" type="select" optional="True" value="interpolated" label="Type of model" help="(-type) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
123 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
124 <option value="b_spline">b_spline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
125 <option value="interpolated">interpolated</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
126 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
127 <param name="param_model_linear_symmetric_regression" type="boolean" truevalue="-model:linear:symmetric_regression" falsevalue="" checked="false" optional="True" label="Perform linear regression on 'y - x' vs" help="(-symmetric_regression) 'y + x', instead of on 'y' vs. 'x'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
128 <param name="param_model_b_spline_wavelength" type="float" min="0.0" optional="True" value="0.0" label="Determines the amount of smoothing by setting the number of nodes for the B-spline" help="(-wavelength) The number is chosen so that the spline approximates a low-pass filter with this cutoff wavelength. The wavelength is given in the same units as the data; a higher value means more smoothing. '0' sets the number of nodes to twice the number of input points"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
129 <param name="param_model_b_spline_num_nodes" type="integer" min="0" optional="True" value="5" label="Number of nodes for B-spline fitting" help="(-num_nodes) Overrides 'wavelength' if set (to two or greater). A lower value means more smoothing"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
130 <param name="param_model_b_spline_extrapolate" type="select" optional="True" value="linear" label="Method to use for extrapolation beyond the original data range" help="(-extrapolate) 'linear': Linear extrapolation using the slope of the B-spline at the corresponding endpoint. 'b_spline': Use the B-spline (as for interpolation). 'constant': Use the constant value of the B-spline at the corresponding endpoint. 'global_linear': Use a linear fit through the data (which will most probably introduce discontinuities at the ends of the data range)">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
131 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
132 <option value="b_spline">b_spline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
133 <option value="constant">constant</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
134 <option value="global_linear">global_linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
135 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
136 <param name="param_model_b_spline_boundary_condition" type="integer" min="0" max="2" optional="True" value="2" label="Boundary condition at B-spline endpoints: 0 (value zero), 1 (first derivative zero) or 2 (second derivative zero)" help="(-boundary_condition) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
137 <param name="param_model_interpolated_interpolation_type" type="select" optional="True" value="cspline" label="Type of interpolation to apply" help="(-interpolation_type) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
138 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
139 <option value="cspline">cspline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
140 <option value="akima">akima</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
141 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
142 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
143 <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
144 <param name="param_algorithm_cutoff_score" type="float" min="0.0" max="1.0" optional="True" value="0.7" label="The Parameter defines the threshold which filtered Spectra, these Spectra are high potential candidate for deciding the interval of a sub-alignment" help="(-cutoff_score) Only those pair of Spectra are selected, which has a score higher or same of the threshold"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
145 <param name="param_algorithm_bucketsize" type="integer" min="1" optional="True" value="100" label="Defines the numbers of buckets" help="(-bucketsize) It is a quantize of the interval of those points, which defines the main alignment(match points). These points have to filtered, to reduce the amount of points for the calculating a smoother spline curve"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
146 <param name="param_algorithm_anchorpoints" type="integer" min="1" max="100" optional="True" value="100" label="Defines the percent of numbers of match points which a selected from one bucket" help="(-anchorpoints) The high score pairs are previously selected. The reduction of match points helps to get a smoother spline curve"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
147 <param name="param_algorithm_mismatchscore" type="float" max="0.0" optional="True" value="-5.0" label="Defines the score of two Spectra if they have no similarity to each othe" help="(-mismatchscore) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
148 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
149 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
150 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
151 <data name="param_out" format="mzml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
152 <data name="param_trafo_out" format="trafoxml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
153 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
154 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
155
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
156 Corrects retention time distortions between maps by spectrum alignment.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
157
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
158
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
159 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_MapAlignerSpectrum.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
160 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
161 </tool>