annotate MapAlignerSpectrum.xml @ 3:ec62782f6c68 draft

Uploaded
author bgruening
date Mon, 13 Oct 2014 10:18:22 -0400
parents 3d84209d3178
children 6ead64a594bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
2 <tool id="MapAlignerSpectrum" name="MapAlignerSpectrum" version="1.12.0">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
3 <description>Corrects retention time distortions between maps by spectrum alignment.</description>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
4 <macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">MapAlignerSpectrum</token>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
6 <import>macros.xml</import>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
7 </macros>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
8 <expand macro="stdio"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
9 <expand macro="requirements"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
10 <command>MapAlignerSpectrum
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
11
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
12 -in ${param_in}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
13 -out ${param_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
14 -trafo_out ${param_trafo_out}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
15 -threads \${GALAXY_SLOTS:-24}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
16 -algorithm:gapcost ${param_gapcost}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
17 -algorithm:affinegapcost ${param_affinegapcost}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
18 -algorithm:scorefunction ${param_scorefunction}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
19 -model:type ${param_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
20 ${param_symmetric_regression}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
21 -model:interpolated:interpolation_type ${param_interpolation_type}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
22 #if $adv_opts.adv_opts_selector=='advanced':
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
23 -algorithm:cutoff_score ${adv_opts.param_cutoff_score}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
24 -algorithm:bucketsize ${adv_opts.param_bucketsize}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
25 -algorithm:anchorpoints ${adv_opts.param_anchorpoints}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
26 -algorithm:mismatchscore ${adv_opts.param_mismatchscore}
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
27 #end if
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
28 </command>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
29 <inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
30 <param name="param_in" type="data" format="mzML" optional="False" size="20" label="Input files separated by blanks (all must have the same file type)" help="(-in)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
31 <param name="param_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. 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." help="(-gapcost)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
32 <param name="param_affinegapcost" type="float" min="0.0" optional="True" value="0.5" label=" This Parameter controls the cost of extension a already open gap. 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 aligmnet show high compression, it is a good idea to lower the affine gapcost or the normal gapcost." help="(-affinegapcost)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
33 <param name="param_scorefunction" type="select" optional="True" value="SteinScottImproveScore" label=" The score function is the core of an alignment. 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." help="(-scorefunction)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
34 <option value="SteinScottImproveScore">SteinScottImproveScore</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
35 <option value="ZhangSimilarityScore">ZhangSimilarityScore</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
36 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
37 <param name="param_type" type="select" optional="True" value="interpolated" label="Type of model" help="(-type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
38 <option value="linear">linear</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
39 <option value="b_spline">b_spline</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
40 <option value="interpolated">interpolated</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
41 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
42 <param name="param_symmetric_regression" type="boolean" truevalue="-model:linear:symmetric_regression true" falsevalue="-model:linear:symmetric_regression false" checked="false" optional="True" label="Perform linear regression on 'y - x' vs. 'y + x', instead of on 'y' vs. 'x'." help="(-symmetric_regression)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
43 <param name="param_interpolation_type" type="select" optional="True" value="cspline" label="Type of interpolation to apply." help="(-interpolation_type)">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
44 <option value="linear">linear</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
45 <option value="cspline">cspline</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
46 <option value="akima">akima</option>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
47 </param>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
48 <expand macro="advanced_options">
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
49 <param name="param_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. Only those pair of Spectra are selected, which has a score higher or same of the threshold." help="(-cutoff_score)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
50 <param name="param_bucketsize" type="integer" min="1" optional="True" value="100" label="Defines the numbers of buckets. 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." help="(-bucketsize)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
51 <param name="param_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. The high score pairs are previously selected. The reduction of match points helps to get a smoother spline curve." help="(-anchorpoints)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
52 <param name="param_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 other. " help="(-mismatchscore)"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
53 </expand>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
54 </inputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
55 <outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
56 <data name="param_out" label="Output files separated by blanks. Either 'out' or 'trafo_out' has to be provided. They can be used together." format="mzML"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
57 <data name="param_trafo_out" label="Transformation output files separated by blanks. Either 'out' or 'trafo_out' has to be provided. They can be used together." format="data"/>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
58 </outputs>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
59 <help>**What it does**
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
60
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
61 Corrects retention time distortions between maps by spectrum alignment.
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
62
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
63
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
64 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_MapAlignerSpectrum.html
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
65
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
66 @REFERENCES@
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
67 </help>
3d84209d3178 Uploaded
bgruening
parents:
diff changeset
68 </tool>