annotate tandem.xml @ 6:e5b29190a4a0 draft

Uploaded
author iracooke
date Tue, 18 Mar 2014 18:46:36 -0400
parents 0eadb9f0852b
children 210d04f6e2c6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
1 <tool id="proteomics_search_tandem_1" name="X!Tandem MSMS Search" version="1.0.1">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
2
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
3 <requirements>
4
0eadb9f0852b Uploaded
iracooke
parents: 2
diff changeset
4 <requirement type="package" version="1.2.6">protk</requirement>
0eadb9f0852b Uploaded
iracooke
parents: 2
diff changeset
5 <requirement type="package" version="4.6.3">trans_proteomic_pipeline</requirement>
0
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
6 </requirements>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
7
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
8 <description>Run an X!Tandem Search</description>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
9
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
10 <command>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
11 #if $database.source_select=="built_in":
4
0eadb9f0852b Uploaded
iracooke
parents: 2
diff changeset
12 tandem_search.rb -d $database.dbkey
0eadb9f0852b Uploaded
iracooke
parents: 2
diff changeset
13 #else
0eadb9f0852b Uploaded
iracooke
parents: 2
diff changeset
14 tandem_search.rb -d $database.fasta_file
0
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
15 #end if
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
16
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
17 --var-mods='
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
18 $variable_mods
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
19 #for $custom_variable_mod in $custom_variable_mods:
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
20 ,${custom_variable_mod.custom_mod}
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
21 #end for
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
22 '
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
23
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
24 --fix-mods='
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
25 $fixed_mods
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
26 #for $custom_fix_mod in $custom_fix_mods:
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
27 ,${custom_fix_mod.custom_mod}
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
28 #end for
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
29 '
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
30
6
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
31 $input_file -o $output -r
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
32
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
33 --enzyme=$enzyme
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
34
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
35 --precursor-ion-tol-units=$precursor_tolu
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
36
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
37 -v $missed_cleavages
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
38
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
39 -f $fragment_ion_tol
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
40
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
41 -p $precursor_ion_tol
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
42
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
43 $allow_multi_isotope_search
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
44
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
45 --keep-params-files
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
46
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
47 $cleavage_semi
0
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
48
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
49 </command>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
50
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
51 <inputs>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
52 <conditional name="database">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
53 <param name="source_select" type="select" label="Database source">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
54 <option value="built_in">Built-In</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
55 <option value="input_ref">Your Upload File</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
56 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
57 <when value="built_in">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
58 <param name="dbkey" type="select" format="text" >
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
59 <label>Database</label>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
60 <options from_file="pepxml_databases.loc">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
61 <column name="name" index="0" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
62 <column name="value" index="2" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
63 </options>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
64 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
65 </when>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
66 <when value="input_ref">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
67 <param name="fasta_file" type="data" format="fasta" label="Uploaded FASTA file" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
68 </when>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
69 </conditional>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
70
7fa8d2e2bd3e 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"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
72
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
73
7fa8d2e2bd3e 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
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
75 clicking to select multiple items">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
76 <options from_file="tandem_mods.loc">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
77 <column name="name" index="0" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
78 <column name="value" index="2" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
79 </options>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
80 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
81
7fa8d2e2bd3e 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).">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
83 <param name="custom_mod" type="text">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
84 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
85 </repeat>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
86
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
87
7fa8d2e2bd3e 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
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
89 clicking to select multiple items">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
90 <options from_file="tandem_mods.loc">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
91 <column name="name" index="0" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
92 <column name="value" index="2" />
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
93 </options>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
94 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
95
7fa8d2e2bd3e 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).">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
97 <param name="custom_mod" type="text">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
98 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
99 </repeat>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
100
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
101
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
102
7fa8d2e2bd3e 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">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
104 <label>Missed Cleavages Allowed</label>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
105 <option value="0">0</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
106 <option value="1">1</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
107 <option value="2">2</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
108 </param>
6
e5b29190a4a0 Uploaded
iracooke
parents: 4
diff changeset
109
e5b29190a4a0 Uploaded
iracooke
parents: 4
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" />
0
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
111
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
112 <param name="enzyme" type="select" format="text">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
113 <label>Enzyme</label>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
114 <option value="Trypsin">Trypsin</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
115 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
116
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
117 <param name="fragment_ion_tol" help="Fragment Ion Tolerance in Daltons" type="float" value="0.65" min="0" max="10000" label="Fragment ion tolerance"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
118
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
119 <param name="precursor_ion_tol" help="Precursor Ion Tolerance (Da or ppm)" type="float" value="100" min="0" max="10000" label="Precursor ion tolerance"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
120 <param name="precursor_tolu" type="select" format="text">
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
121 <label>Precursor Ion Tolerance Units</label>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
122 <option value="ppm">ppm</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
123 <option value="Da">Da</option>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
124 </param>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
125
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
126 <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"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
127
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
128 </inputs>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
129
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
130
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
131 <outputs>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
132 <data format="raw_pepxml" 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}.pepXML"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
133 </outputs>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
134
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
135 <tests>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
136 <test>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
137 <param name="source_select" value="input_ref"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
138 <param name="fasta_file" value="bsa.fasta"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
139 <param name="input_file" value="bsa.mzML"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
140 <param name="variable_mods" value="15.994915@M"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
141 <param name="fixed_mods" value="57.021464@C"/>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
142 <param name="allow_multi_isotope_search" value="false"/>
1
0df91f1ff477 Functional Test Fix
Ira Cooke <iracooke@gmail.com>
parents: 0
diff changeset
143 <output name="output" file="bsa.pepXML" compare="sim_size" delta="600" />
0
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
144 </test>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
145 </tests>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
146
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
147
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
148 <help>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
149
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
150 **What it does**
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
151
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
152 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.
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
153
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
154 ----
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
155
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
156 **References**
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
157
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
158 Please see http://www.thegpm.org/GPM/references.html for details of references describing the X!Tandem search engine.
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
159
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
160 </help>
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
161
7fa8d2e2bd3e Uploaded
iracooke
parents:
diff changeset
162 </tool>