annotate tandem.xml @ 12:be958beb41d9 draft

Uploaded
author iracooke
date Sun, 08 Jun 2014 00:18:26 -0400
parents
children 2826f4b12b0b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
1 <tool id="proteomics_search_tandem_1" name="X!Tandem MSMS Search" version="1.0.2">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
2
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
3 <!-- <requirements>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
4 <requirement type="package" version="1.2.6">protk</requirement>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
5 <requirement type="package" version="4.6.3">trans_proteomic_pipeline</requirement>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
6 </requirements>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
7 -->
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
8 <description>Run an X!Tandem Search</description>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
9
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
10 <command>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
11 #if $database.source_select=="built_in":
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
12 tandem_search.rb -d $database.dbkey
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
13 #else
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
14 tandem_search.rb -d $database.fasta_file
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
15 #end if
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
16
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
17 --var-mods='
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
18 $variable_mods
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
19 #for $custom_variable_mod in $custom_variable_mods:
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
20 ,${custom_variable_mod.custom_mod}
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
21 #end for
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
22 '
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
23
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
24 --fix-mods='
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
25 $fixed_mods
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
26 #for $custom_fix_mod in $custom_fix_mods:
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
27 ,${custom_fix_mod.custom_mod}
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
28 #end for
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
29 '
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
30
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
31 $input_file -o $output -r
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
32
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
33 --enzyme=$enzyme
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
34
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
35 --precursor-ion-tol-units=$precursor_tolu
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
36
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
37 -v $missed_cleavages
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
38
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
39 -f $fragment_ion_tol
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
40
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
41 -p $precursor_ion_tol
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
42
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
43 $allow_multi_isotope_search
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
44
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
45 --keep-params-files
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
46
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
47 $cleavage_semi
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
48
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
49 </command>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
50
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
51 <inputs>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
52 <conditional name="database">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
53 <param name="source_select" type="select" label="Database source">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
54 <option value="built_in">Built-In</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
55 <option value="input_ref" selected="true">Your Upload File</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
56 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
57 <when value="built_in">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
58 <param name="dbkey" type="select" format="text" >
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
59 <label>Database</label>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
60 <options from_file="pepxml_databases.loc">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
61 <column name="name" index="0" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
62 <column name="value" index="2" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
63 </options>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
64 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
65 </when>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
66 <when value="input_ref">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
67 <param name="fasta_file" type="data" format="fasta" label="Uploaded FASTA file" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
68 </when>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
69 </conditional>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
70
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
71 <param name="input_file" type="data" format="mzml" multiple="false" label="MSMS File" help="An mzML file with MS/MS data"/>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
72
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
73
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
74 <param name="variable_mods" format="text" type="select" multiple="true" label="Variable Modifications" help="Hold the appropriate key while
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
75 clicking to select multiple items">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
76 <options from_file="tandem_mods.loc">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
77 <column name="name" index="0" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
78 <column name="value" index="2" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
79 </options>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
80 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
81
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
82 <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).">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
83 <param name="custom_mod" type="text">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
84 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
85 </repeat>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
86
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
87
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
88 <param name="fixed_mods" format="text" type="select" multiple="true" label="Fixed Modifications" help="Hold the appropriate key while
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
89 clicking to select multiple items">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
90 <options from_file="tandem_mods.loc">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
91 <column name="name" index="0" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
92 <column name="value" index="2" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
93 </options>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
94 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
95
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
96 <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).">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
97 <param name="custom_mod" type="text">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
98 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
99 </repeat>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
100
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
101
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
102
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
103 <param name="missed_cleavages" type="select" format="text" help="Allow peptides to contain up to this many missed enzyme cleavage sites">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
104 <label>Missed Cleavages Allowed</label>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
105 <option value="0">0</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
106 <option value="1">1</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
107 <option value="2">2</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
108 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
109
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
110 <param name="cleavage_semi" type="boolean" label="Allow semi-cleaved peptides" help="This can increase search time dramatically" truevalue="" falsevalue="--no-cleavage-semi" />
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
111
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
112 <param name="enzyme" type="select" format="text">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
113 <label>Enzyme</label>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
114 <option value="[R]|{P}">argc - [R]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
115 <option value="[X]|[D]">aspn - [X]|[D]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
116 <option value="[FLMWY]|{P}">chymotrypsin - [FLMWY]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
117 <option value="[R]|[X]">clostripain - [R]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
118 <option value="[M]|{P}">cnbr - [M]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
119 <option value="[AGILV]|{P}">elastase - [AGILV]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
120 <option value="[D]|{P}">formicacid - [D]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
121 <option value="[DE]|{P}">gluc - [DE]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
122 <option value="[E]|{P}">gluc_bicarb - [E]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
123 <option value="[W]|[X]">iodosobenzoate - [W]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
124 <option value="[K]|{P}">lysc - [K]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
125 <option value="[K]|[X]">lysc-p - [K]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
126 <option value="[X]|[K]">lysn - [X]|[K]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
127 <option value="[X]|[AKRS]">lysn_promisc - [X]|[AKRS]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
128 <option value="[X]|[X]">nonspecific - [X]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
129 <option value="[FL]|[X]">pepsina - [FL]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
130 <option value="[P]|[X]">protein_endopeptidase - [P]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
131 <option value="[E]|[X]">staph_protease - [E]|[X]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
132 <option value="[FMWY]|{P},[KR]|{P},[X]|[D]">tca - [FMWY]|{P},[KR]|{P},[X]|[D]</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
133 <option value="[KR]|{P}" selected="true">trypsin - [KR]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
134 <option value="[FKLMRWY]|{P}">trypsin/chymotrypsin - [FKLMRWY]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
135 <option value="[KR]|{P},[M]|{P}">trypsin/cnbr - [KR]|{P},[M]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
136 <option value="[DEKR]|{P}">trypsin_gluc - [DEKR]|{P}</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
137 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
138
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
139
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
140 <param name="fragment_ion_tol" help="Fragment Ion Tolerance in Daltons" type="float" value="0.65" min="0" max="10000" label="Fragment ion tolerance"/>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
141
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
142 <param name="precursor_ion_tol" help="Precursor Ion Tolerance (Da or ppm)" type="float" value="100" min="0" max="10000" label="Precursor ion tolerance"/>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
143 <param name="precursor_tolu" type="select" format="text">
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
144 <label>Precursor Ion Tolerance Units</label>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
145 <option value="ppm">ppm</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
146 <option value="Da">Da</option>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
147 </param>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
148
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
149 <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="" falsevalue="--strict-monoisotopic-mass"/>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
150
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
151 </inputs>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
152
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
153
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
154 <outputs>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
155 <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"/>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
156 </outputs>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
157
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
158
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
159 <help>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
160
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
161 **What it does**
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
162
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
163 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.
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
164
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
165 ----
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
166
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
167 **References**
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
168
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
169 Please see http://www.thegpm.org/GPM/references.html for details of references describing the X!Tandem search engine.
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
170
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
171 </help>
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
172
be958beb41d9 Uploaded
iracooke
parents:
diff changeset
173 </tool>