annotate tandem.xml @ 17:aadf13041508 draft

Uploaded
author simonalpha
date Mon, 05 Jan 2015 00:56:19 -0500
parents
children 529ea20c1e6c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
1 <tool id="proteomics_search_tandem_1" name="X!Tandem MSMS Search" version="1.0.4">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
2
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
3 <requirements>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
4 <container type="docker">simonalpha/protk:1.4.0</container>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
5 <requirement type="package" version="1.4">protk</requirement>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
6 </requirements>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
7
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
8 <description>Run an X!Tandem Search</description>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
9
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
10 <command>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
11 #if $database.source_select=="built_in":
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
12 tandem_search.rb -d $database.dbkey
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
13 #else
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
14 tandem_search.rb -d $database.fasta_file
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
15 #end if
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
16
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
17 #if $tandem_params.source_select=="built_in":
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
18 -T $tandem_params.paramskey
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
19 #else
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
20 -T $tandem_params.params_file
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
21 #end if
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
22
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
23
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
24 --var-mods='
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
25 $variable_mods
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
26 #for $custom_variable_mod in $custom_variable_mods:
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
27 ,${custom_variable_mod.custom_mod}
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
28 #end for
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
29 '
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
30
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
31 --fix-mods='
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
32 $fixed_mods
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
33 #for $custom_fix_mod in $custom_fix_mods:
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
34 ,${custom_fix_mod.custom_mod}
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
35 #end for
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
36 '
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
37
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
38 $input_file -o $output -r
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
39
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
40 --enzyme=$enzyme
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
41
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
42 --precursor-ion-tol-units=$precursor_tolu
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
43
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
44 -v $missed_cleavages
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
45
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
46 -f $fragment_ion_tol
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
47
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
48 -p $precursor_ion_tol
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
49
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
50 $allow_multi_isotope_search
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
51
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
52 $acetyl_protein_nterm
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
53
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
54 $cleavage_semi
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
55
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
56 $keep_spectra
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
57
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
58 --threads $threads
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
59
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
60 </command>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
61
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
62 <inputs>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
63 <conditional name="database">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
64 <param name="source_select" type="select" label="Database source">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
65 <option value="built_in">Built-In</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
66 <option value="input_ref" selected="true">Your Upload File</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
67 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
68 <when value="built_in">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
69 <param name="dbkey" type="select" format="text" >
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
70 <label>Database</label>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
71 <options from_file="pepxml_databases.loc">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
72 <column name="name" index="0" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
73 <column name="value" index="2" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
74 </options>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
75 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
76 </when>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
77 <when value="input_ref">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
78 <param name="fasta_file" type="data" format="fasta" label="Uploaded FASTA file" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
79 </when>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
80 </conditional>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
81
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
82 <conditional name="tandem_params">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
83 <param name="source_select" type="select" label="Baseline Parameters">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
84 <option value="built_in" selected="true">Built-In</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
85 <option value="input_ref">Custom parameter file</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
86 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
87 <when value="built_in">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
88 <param name="paramskey" type="select" format="text" >
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
89 <label>Paramset</label>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
90 <option value="isb_kscore">ISB K-Score (Recommended for TPP)</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
91 <option value="isb_native">ISB Native</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
92 <option value="gpm">GPM</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
93 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
94 </when>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
95 <when value="input_ref">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
96 <param name="params_file" type="data" format="xml" label="Custom X!Tandem Parameters" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
97 </when>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
98 </conditional>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
99
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
100 <param name="input_file" type="data" format="mzml,mgf" multiple="false" label="MSMS File" help="A file with MS/MS data"/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
101
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
102 <param name="variable_mods" format="text" type="select" multiple="true" label="Variable Modifications" help="Hold the appropriate key while
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
103 clicking to select multiple items">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
104 <options from_file="tandem_mods.loc">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
105 <column name="name" index="0" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
106 <column name="value" index="2" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
107 </options>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
108 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
109
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
110 <repeat name="custom_variable_mods" title="Custom Variable Modifications" help="You can specify a modification when present in a motif. For instance, 0.998@N!{P}[ST] is a deamidation modification on N only if it is present in an N[any but P][S or T] motif (N-glycosite).">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
111 <param name="custom_mod" type="text">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
112 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
113 </repeat>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
114
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
115
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
116 <param name="fixed_mods" format="text" type="select" multiple="true" label="Fixed Modifications" help="Hold the appropriate key while
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
117 clicking to select multiple items">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
118 <options from_file="tandem_mods.loc">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
119 <column name="name" index="0" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
120 <column name="value" index="2" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
121 </options>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
122 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
123
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
124 <repeat name="custom_fix_mods" title="Custom Fixed Modifications" help="You can specify a modification when present in a motif. For instance, 0.998@N!{P}[ST] is a deamidation modification on N only if it is present in an N[any but P][S or T] motif (N-glycosite).">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
125 <param name="custom_mod" type="text">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
126 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
127 </repeat>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
128
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
129 <param name="acetyl_protein_nterm" type="boolean" label="Allow N-terminal protein acetylation as a variable modification" truevalue="-y" falsevalue="" />
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
130
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
131
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
132 <param name="missed_cleavages" type="select" format="text" help="Allow peptides to contain up to this many missed enzyme cleavage sites">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
133 <label>Missed Cleavages Allowed</label>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
134 <option value="0">0</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
135 <option value="1">1</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
136 <option selected="true" value="2">2</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
137 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
138
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
139 <param name="cleavage_semi" type="boolean" label="Allow semi-cleaved peptides" help="This can increase search time dramatically" truevalue="--cleavage-semi" falsevalue=""/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
140
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
141 <param name="keep_spectra" type="boolean" label="Keep Spectra" help="Include spectra in the output" truevalue="--output-spectra" falsevalue=""/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
142
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
143 <param name="threads" type="integer" value="1" label="Threads" help="Number of threads to use for search. Maximum is 16"/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
144
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
145 <param name="enzyme" type="select" format="text">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
146 <label>Enzyme</label>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
147 <option value="[R]__pc__{P}">argc - [R]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
148 <option value="[X]__pc__[D]">aspn - [X]|[D]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
149 <option value="[FLMWY]__pc__{P}">chymotrypsin - [FLMWY]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
150 <option value="[R]__pc__[X]">clostripain - [R]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
151 <option value="[M]__pc__{X}">cnbr - [M]|{X}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
152 <option value="[AGILV]__pc__{P}">elastase - [AGILV]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
153 <option value="[D]__pc__{P}">formicacid - [D]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
154 <option value="[DE]__pc__{P}">gluc - [DE]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
155 <option value="[E]__pc__{P}">gluc_bicarb - [E]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
156 <option value="[W]__pc__[X]">iodosobenzoate - [W]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
157 <option value="[K]__pc__{P}">lysc - [K]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
158 <option value="[K]__pc__[X]">lysc-p - [K]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
159 <option value="[X]__pc__[K]">lysn - [X]|[K]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
160 <option value="[X]__pc__[AKRS]">lysn_promisc - [X]|[AKRS]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
161 <option value="[X]__pc__[X]">nonspecific - [X]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
162 <option value="[FL]__pc__[X]">pepsina - [FL]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
163 <option value="[P]__pc__[X]">protein_endopeptidase - [P]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
164 <option value="[E]__pc__[X]">staph_protease - [E]|[X]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
165 <option value="[FMWY]__pc__{P},[KR]__pc__{P},[X]__pc__[D]">tca - [FMWY]|{P},[KR]|{P},[X]|[D]</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
166 <option value="[KR]__pc__{P}" selected="true">trypsin - [KR]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
167 <option value="[FKLMRWY]__pc__{P}">trypsin/chymotrypsin - [FKLMRWY]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
168 <option value="[KR]__pc__{P},[M]__pc__{P}">trypsin/cnbr - [KR]|{P},[M]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
169 <option value="[DEKR]__pc__{P}">trypsin_gluc - [DEKR]|{P}</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
170 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
171
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
172
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
173 <param name="fragment_ion_tol" help="Fragment Ion Tolerance in Daltons" type="float" value="0.5" min="0" max="10000" label="Fragment ion tolerance"/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
174
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
175 <param name="precursor_ion_tol" help="Precursor Ion Tolerance (Da or ppm)" type="float" value="10" min="0" max="10000" label="Precursor ion tolerance"/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
176 <param name="precursor_tolu" type="select" format="text">
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
177 <label>Precursor Ion Tolerance Units</label>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
178 <option value="ppm">ppm</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
179 <option value="Da">Da</option>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
180 </param>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
181
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
182 <param name="allow_multi_isotope_search" type="boolean" label="Allow multi-isotope search" help="This allows peptide candidates in windows around -1 Da and -2 Da from the acquired mass to be considered. Only applicable when the minus/plus window above is set to less than 0.5 Da. Good for accurate-mass instruments for which the reported precursor mass is not corrected to the monoisotopic mass." truevalue="--multi-isotope-search" falsevalue=""/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
183
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
184 </inputs>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
185
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
186
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
187 <outputs>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
188 <data format="tandem" name="output" metadata_source="input_file" label="X!Tandem_vs_${database.dbkey if $database.has_key('dbkey') else $database.fasta_file.display_name}.${input_file.display_name}.${input_file.display_name}.tandem"/>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
189 </outputs>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
190
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
191
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
192 <help>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
193
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
194 **What it does**
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
195
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
196 Runs an MS/MS database search using the X!Tandem search engine. Output is in the form of a pepXML file containing identified peptides along with their raw search scores.
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
197
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
198 ----
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
199
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
200 **References**
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
201
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
202 Please see http://www.thegpm.org/GPM/references.html for details of references describing the X!Tandem search engine.
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
203
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
204 </help>
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
205
aadf13041508 Uploaded
simonalpha
parents:
diff changeset
206 </tool>