annotate MapAlignerIdentification.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="MapAlignerIdentification" name="MapAlignerIdentification" version="2.0.0">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
3 <description>Corrects retention time distortions between maps based on common peptide identifications.</description>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
4 <macros>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
5 <token name="@EXECUTABLE@">MapAlignerIdentification</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>MapAlignerIdentification
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_reference_file:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
40 -reference:file $param_reference_file
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
41 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
42 #if $param_reference_index:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
43 -reference:index $param_reference_index
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
44 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
45 #if $param_algorithm_peptide_score_threshold:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
46 -algorithm:peptide_score_threshold $param_algorithm_peptide_score_threshold
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
47 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
48 #if $param_algorithm_min_run_occur:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
49 -algorithm:min_run_occur $param_algorithm_min_run_occur
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
50 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
51 #if $param_algorithm_max_rt_shift:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
52 -algorithm:max_rt_shift $param_algorithm_max_rt_shift
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
53 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
54 #if $param_algorithm_use_unassigned_peptides:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
55 -algorithm:use_unassigned_peptides
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
56 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
57 #if $param_algorithm_use_feature_rt:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
58 -algorithm:use_feature_rt
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
59 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
60 #if $param_model_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
61 -model:type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
62 #if " " in str($param_model_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
63 "$param_model_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
64 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
65 $param_model_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
66 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
67 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
68 #if $param_model_linear_symmetric_regression:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
69 -model:linear:symmetric_regression
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
70 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
71 #if $param_model_b_spline_wavelength:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
72 -model:b_spline:wavelength $param_model_b_spline_wavelength
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
73 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
74 #if $param_model_b_spline_num_nodes:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
75 -model:b_spline:num_nodes $param_model_b_spline_num_nodes
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
76 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
77 #if $param_model_b_spline_extrapolate:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
78 -model:b_spline:extrapolate
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
79 #if " " in str($param_model_b_spline_extrapolate):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
80 "$param_model_b_spline_extrapolate"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
81 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
82 $param_model_b_spline_extrapolate
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
83 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
84 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
85 #if $param_model_b_spline_boundary_condition:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
86 -model:b_spline:boundary_condition $param_model_b_spline_boundary_condition
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
87 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
88 #if $param_model_interpolated_interpolation_type:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
89 -model:interpolated:interpolation_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
90 #if " " in str($param_model_interpolated_interpolation_type):
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
91 "$param_model_interpolated_interpolation_type"
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
92 #else
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
93 $param_model_interpolated_interpolation_type
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
94 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
95 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
96 #if $adv_opts.adv_opts_selector=='advanced':
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
97 #if $adv_opts.param_force:
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
98 -force
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
99 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
100 #end if
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
101 </command>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
102 <inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
103 <param name="param_in" type="data" format="featurexml,consensusxml,idxml" 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
104 <sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
105 <valid initial="string.printable">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
106 <remove value="'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
107 <remove value="&quot;"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
108 </valid>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
109 </sanitizer>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
110 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
111 <param name="param_reference_file" type="data" format="featurexml,consensusxml,idxml" optional="True" label="File to use as reference (same file format as input files required)" help="(-file) "/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
112 <param name="param_reference_index" type="integer" min="0" optional="True" value="0" label="Use one of the input files as reference ('1' for the first file, etc.)" help="(-index) &lt;br&gt;If '0', no explicit reference is set - the algorithm will select a reference"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
113 <param name="param_algorithm_peptide_score_threshold" type="float" value="0.0" label="Score threshold for peptide hits to be used in the alignment" help="(-peptide_score_threshold) &lt;br&gt;Select a value that allows only 'high confidence' matches"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
114 <param name="param_algorithm_min_run_occur" type="integer" min="2" optional="True" value="2" label="Minimum number of runs (incl" help="(-min_run_occur) reference, if any) a peptide must occur in to be used for the alignment. &lt;br&gt;Unless you have very few runs or identifications, increase this value to focus on more informative peptides"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
115 <param name="param_algorithm_max_rt_shift" type="float" min="0.0" optional="True" value="0.5" label="Maximum realistic RT difference for a peptide (median per run vs" help="(-max_rt_shift) reference). Peptides with higher shifts (outliers) are not used to compute the alignment. &lt;br&gt;If 0, no limit (disable filter); if &gt; 1, the final value in seconds; if &lt;= 1, taken as a fraction of the range of the reference RT scale"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
116 <param name="param_algorithm_use_unassigned_peptides" type="boolean" truevalue="-algorithm:use_unassigned_peptides" falsevalue="" checked="true" optional="True" label="Should unassigned peptide identifications be used when computing an alignment of feature maps?" help="(-use_unassigned_peptides) If 'false', only peptide IDs assigned to features will be used"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
117 <param name="param_algorithm_use_feature_rt" type="boolean" truevalue="-algorithm:use_feature_rt" falsevalue="" checked="false" optional="True" label="When aligning feature maps, don't use the retention time of a peptide identification directly; instead, use the retention time of the centroid of the feature (apex of the elution profile) that the peptide was matched to" help="(-use_feature_rt) If different identifications are matched to one feature, only the peptide closest to the centroid in RT is used. &lt;br&gt;Precludes 'use_unassigned_peptides'"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
118 <param name="param_model_type" type="select" optional="True" value="b_spline" label="Type of model" help="(-type) ">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
119 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
120 <option value="b_spline">b_spline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
121 <option value="interpolated">interpolated</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
122 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
123 <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
124 <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
125 <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
126 <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
127 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
128 <option value="b_spline">b_spline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
129 <option value="constant">constant</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
130 <option value="global_linear">global_linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
131 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
132 <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
133 <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
134 <option value="linear">linear</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
135 <option value="cspline">cspline</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
136 <option value="akima">akima</option>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
137 </param>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
138 <expand macro="advanced_options">
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
139 <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
140 </expand>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
141 </inputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
142 <outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
143 <data name="param_out" metadata_source="param_in" format="input"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
144 <data name="param_trafo_out" format="trafoxml"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
145 </outputs>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
146 <help>**What it does**
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
147
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
148 Corrects retention time distortions between maps based on common peptide identifications.
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
149
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
150
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
151 For more information, visit http://ftp.mi.fu-berlin.de/OpenMS/release-documentation/html/TOPP_MapAlignerIdentification.html</help>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
152 <expand macro="references"/>
3070d71e0e5c Uploaded
bgruening
parents:
diff changeset
153 </tool>