annotate msgfplus_search.xml @ 15:6c751c59ce18 draft

Docker support and update for protk 1.4
author iracooke
date Thu, 26 Mar 2015 20:04:30 -0400
parents 32365fec702c
children 66a149ef79f7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
1 <tool id="proteomics_search_msgfplus_1" name="MSGF+ MSMS Search" version="1.1.0">
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
2 <description>Run an MSGF+ Search</description>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
3 <requirements>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
4 <container type="docker">iracooke/protk-1.4.1</container>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
5 <requirement type="package" version="1.4">protk</requirement>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
6 <requirement type="package" version="20140210">msgfplus</requirement>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
7 <requirement type="package" version="3_0_4388">proteowizard</requirement>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
8 </requirements>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
9 <command>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
10 msgfplus_search.rb
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
11 #if $database.source_select=="built_in":
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
12 --galaxy -d $database.dbkey
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
13 #else
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
14 --galaxy -d $database.fasta_file
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
15 #end if
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
16
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
17 --var-mods='
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
18 $variable_mods
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
19 #for $custom_variable_mod in $custom_variable_mods:
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
20 ,${custom_variable_mod.custom_mod}
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
21 #end for
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
22 '
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
23
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
24 --fix-mods='
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
25 $fixed_mods
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
26 #for $custom_fix_mod in $custom_fix_mods:
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
27 ,${custom_fix_mod.custom_mod}
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
28 #end for
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
29 '
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
30
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
31 $input_file
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
32 -o $output
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
33 -r
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
34 --enzyme=$enzyme
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
35 --precursor-ion-tol-units=$precursor_tolu
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
36 -v $missed_cleavages
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
37 $cleavage_semi
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
38 -p $precursor_ion_tol
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
39 --instrument=$instrument
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
40 --isotope-error-range=$isotope_error_range
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
41 --fragment-method=$fragment_method
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
42 --protocol=$protocol
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
43 --min-pep-len=$min_pep_len
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
44 --max-pep-len=$max_pep_len
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
45 --max-pep-charge=$max_pep_charge
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
46 --min-pep-charge=$min_pep_charge
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
47 --num-reported-matches=$num_reported_matches
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
48 --java-mem=$java_mem
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
49
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
50 --threads $threads
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
51
12
49231acb2258 Uploaded
iracooke
parents: 11
diff changeset
52 #if $pepxml_output_use:
49231acb2258 Uploaded
iracooke
parents: 11
diff changeset
53 --pepxml
13
c1df871ffa3c Uploaded
iracooke
parents: 12
diff changeset
54 #end if
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
55 </command>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
56
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
57 <inputs>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
58 <conditional name="database">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
59 <param name="source_select" type="select" label="Database source">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
60 <option value="built_in">Built-In</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
61 <option value="input_ref" selected="true">Your Upload File</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
62 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
63 <when value="built_in">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
64 <param name="dbkey" type="select" format="text" >
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
65 <label>Database</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
66 <options from_file="pepxml_databases.loc">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
67 <column name="name" index="0" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
68 <column name="value" index="2" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
69 </options>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
70 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
71 </when>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
72 <when value="input_ref">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
73 <param name="fasta_file" type="data" format="fasta" label="Uploaded FASTA file" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
74 </when>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
75 </conditional>
14
32365fec702c Uploaded
iracooke
parents: 13
diff changeset
76 <param name="input_file" type="data" format="mzml" multiple="false" label="MSMS File" help="An mzML file with MS/MS data"/>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
77 <param name="variable_mods" format="text" type="select" multiple="true" label="Variable Modifications" help="Multiple Selection Allowed">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
78 <options from_file="msgfplus_mods.loc">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
79 <column name="name" index="0" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
80 <column name="value" index="2" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
81 </options>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
82 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
83 <repeat name="custom_variable_mods" title="Custom Variable Modifications"
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
84 help="See https://bix-lab.ucsd.edu/pages/viewpage.action?pageId=13533355 for details on how to create these">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
85 <param name="custom_mod" type="text" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
86 </repeat>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
87 <param name="fixed_mods" format="text" type="select" multiple="true" label="Fixed Modifications" help="Multiple Selection Allowed">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
88 <options from_file="msgfplus_mods.loc">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
89 <column name="name" index="0" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
90 <column name="value" index="2" />
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
91 </options>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
92 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
93 <repeat name="custom_fix_mods" title="Custom Fixed Modifications" help="See https://bix-lab.ucsd.edu/pages/viewpage.action?pageId=13533355 for details on how to create these">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
94 <param name="custom_mod" type="text">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
95 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
96 </repeat>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
97 <param name="missed_cleavages" type="select" format="text" help="Allow peptides to contain up to this many missed enzyme cleavage sites">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
98 <label>Missed Cleavages Allowed</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
99 <option value="0">0</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
100 <option value="1">1</option>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
101 <option selected="true" value="2">2</option>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
102 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
103
11
deb61a965680 Uploaded
iracooke
parents: 10
diff changeset
104 <param name="cleavage_semi" type="boolean" label="Allow semi-cleaved peptides" help="This can increase search time dramatically" truevalue="--cleavage-semi" falsevalue="" />
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
105
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
106 <param name="enzyme" type="select" format="text">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
107 <label>Enzyme</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
108 <option value="0">unspecific cleavage</option>
12
49231acb2258 Uploaded
iracooke
parents: 11
diff changeset
109 <option value="1" selected="true">Trypsin</option>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
110 <option value="2">Chymotrypsin</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
111 <option value="3">Lys-C</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
112 <option value="4">Lys-N</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
113 <option value="5">glutamyl endopeptidase</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
114 <option value="6">Arg-C</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
115 <option value="7">Asp-N</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
116 <option value="8">alphaLP</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
117 <option value="9">no cleavage</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
118 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
119
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
120 <param name="instrument" type="select" format="text">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
121 <label>Instrument Type</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
122 <option value="2">TOF</option>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
123 <option value="0" selected="true">Low-res LCQ/LTQ</option>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
124 <option value="1">High-res LTQ</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
125 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
126
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
127 <param name="fragment_method" type="select" format="text">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
128 <label>Fragmentation Method</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
129 <option value="0">Respect Input File</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
130 <option value="1">CID</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
131 <option value="2">ETD</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
132 <option value="3">HCD</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
133 <option value="4">Merge spectra from same precursor</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
134 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
135
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
136 <param name="protocol" type="select" format="text">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
137 <label>Protocol</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
138 <option value="0">NoProtocol</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
139 <option value="1">Phosphorylation</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
140 <option value="2">iTRAQ</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
141 <option value="3">iTRAQPhospho</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
142 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
143
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
144 <param name="precursor_ion_tol" help="Precursor Ion Tolerance (Da or ppm)" type="float" value="10" min="0" max="10000" label="Precursor ion tolerance"/>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
145 <param name="precursor_tolu" type="select" format="text">
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
146 <label>Precursor Ion Tolerance Units</label>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
147 <option value="ppm">ppm</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
148 <option value="Da">Da</option>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
149 </param>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
150
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
151 <param name="isotope_error_range" help="Takes into account of the error introduced by chooosing a non-monoisotopic peak for fragmentation." type="text" size="80" value="0,1" label="Isotope Error Range"/>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
152 <param name="min_pep_len" help="" type="integer" value="6" label="Minimum Peptide Length"/>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
153 <param name="max_pep_len" help="" type="integer" value="40" label="Maximum Peptide Length"/>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
154 <param name="min_pep_charge" help="" type="integer" value="2" label="Minimum Peptide Charge"/>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
155 <param name="max_pep_charge" help="" type="integer" value="3" label="Maximum Peptide Charge"/>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
156 <param name="num_reported_matches" help="Number of matches per spectrum to be reported" type="integer" value="1" label="Num reported matches"/>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
157 <param name="java_mem" help="Increase this value if you get out of memory errors" type="text" size="80" value="3500M" label="Java Memory Limit"/>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
158 <param name="threads" type="integer" value="1" label="Threads" help="Number of threads to use for search."/>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
159 <param name="pepxml_output_use" checked="true" type="boolean" label="Convert results to pepXML" help="" truevalue="true" falsevalue="false" />
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
160 </inputs>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
161 <outputs>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
162 <data format="mzid" name="output" metadata_source="input_file" label="MSGF+_vs_${database.dbkey if $database.has_key('dbkey') else $database.fasta_file.display_name}.${input_file.display_name}.${input_file.display_name}.${'pepXML' if $pepxml_output_use else 'mzid'}">
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
163 <change_format>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
164 <when input="pepxml_output_use" value="true" format="raw_pepxml" metadata_source="input_file"/>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
165 </change_format>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
166 </data>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
167 </outputs>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
168
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
169 <tests>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
170 <!-- Just test that the tool runs and produces vaguely correct output -->
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
171 <test>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
172 <param name="source_select" value="input_ref"/>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
173 <param name="fasta_file" value="testdb.fasta" format="fasta"/>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
174 <param name="input_file" value="tiny.mzML" format="mzml"/>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
175 <param name="precursor_ion_tol" value="200"/>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
176 <param name="pepxml_output_use" value="true"/>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
177 <output name="output" format="raw_pepxml">
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
178 <assert_contents>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
179 <has_text text="FALPQYLKTVYQHQKAMKPWIQPKTKVIPYVRYL" />
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
180 </assert_contents>
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
181 </output>
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
182 </test>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
183 </tests>
15
6c751c59ce18 Docker support and update for protk 1.4
iracooke
parents: 14
diff changeset
184
10
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
185 <help>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
186
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
187 **What it does**
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
188
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
189 Runs an MS/MS database search using the MSGFPlus search engine. Output is in the form of a pepXML file containing identified peptides along with their raw search scores.
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
190
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
191 ----
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
192
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
193 **References**
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
194
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
195 Please see http://proteomics.ucsd.edu/Software/MSGFPlus.html for details of the MSGFPlus search engine and references describing its algorithm
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
196
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
197 </help>
86daefc0e88d Uploaded
iracooke
parents:
diff changeset
198 </tool>