annotate isobaric_analyzer.xml @ 5:9816d9abb501 draft

Added repo dependencies
author galaxyp
date Thu, 20 Jun 2013 16:12:09 -0400
parents 1183846e70a1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
1 <tool id="isobaric_analyzer" version="0.1.0" name="iTRAQ/TMT Analyzer">
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
2 <description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
3 Extracts and normalizes iTRAQ/TMT information from an MS experiment.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
4 </description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
5 <macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
6 <import>macros.xml</import>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
7 </macros>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
8 <expand macro="stdio" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
9 <expand macro="requires" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
10 <command interpreter="python">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
11 #set $label_type = str($type.label_type)
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
12 #if $label_type == "tmt-6plex"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
13 #set $program = "TMTAnalyzer"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
14 #else
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
15 #set $program = "ITRAQAnalyzer"
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
16 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
17 openms_wrapper.py
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
18 --executable '$program' --config $config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
19 </command>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
20 <configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
21 <configfile name="config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
22 in=$input1
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
23 out=$out
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
24 Extraction!reporter_mass_shift=$reporter_mass_shift
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
25 Extraction!select_activation=$select_activation
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
26 Quantification!isotope_correction=$isotope_correction
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
27 Quantification!do_normalization=$do_normalization
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
28 Quantification!channel_reference=$type.channel_reference
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
29 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
30 </configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
31 <inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
32 <param name="input1" type="data" format="mzml" label="Input peak list" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
33 <conditional name="type">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
34 <param name="label_type" type="select" label="Labels">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
35 <option value="4plex">iTRAQ 4-Plex</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
36 <option value="8plex">iTRAQ 8-Plex</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
37 <option value="tmt-6plex">TMT 6-plex</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
38 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
39 <when value="4plex">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
40 <param name="channel_reference" type="select" label="Reference Channel">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
41 <option value="114">114</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
42 <option value="115">115</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
43 <option value="116">116</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
44 <option value="117">117</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
45 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
46 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
47 <when value="8plex">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
48 <param name="channel_reference" type="select" label="Reference Channel">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
49 <option value="113">113</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
50 <option value="114">114</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
51 <option value="115">115</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
52 <option value="116">116</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
53 <option value="117">117</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
54 <option value="118">118</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
55 <option value="119">119</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
56 <option value="121">121</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
57 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
58 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
59 <when value="tmt-6plex">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
60 <param name="channel_reference" type="select" label="Reference Channel">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
61 <option value="126">126</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
62 <option value="127">127</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
63 <option value="128">128</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
64 <option value="129">129</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
65 <option value="130">130</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
66 <option value="131">131</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
67 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
68 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
69 </conditional>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
70 <param name="select_activation" type="select" label="Select Activation" help="Operate only on MSn scans where any of its precursors features a certain activation method (usually HCD for iTRAQ). Set to empty string if you want to disable filtering.">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
71 <option value="">(Leave empty,use all MSn.)</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
72 <option value="Collision-induced dissociation">Collision-induced dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
73 <option value="Post-source decay">Post-source decay</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
74 <option value="Plasma desorption">Plasma desorption</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
75 <option value="Surface-induced dissociation">Surface-induced dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
76 <option value="Blackbody infrared radiative dissociation">Blackbody infrared radiative dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
77 <option value="Electron capture dissociation">Electron capture dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
78 <option value="Infrared multiphoton dissociation">Infrared multiphoton dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
79 <option value="Sustained off-resonance irradiation">Sustained off-resonance irradiation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
80 <option value="High-energy collision-induced dissociation" selected="true">High-energy collision-induced dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
81 <option value="Low-energy collision-induced dissociation">Low-energy collision-induced dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
82 <option value="Photodissociation">Photodissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
83 <option value="Electron transfer dissociation">Electron transfer dissociation</option>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
84 </param>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
85 <param name="reporter_mass_shift" label="Reporter Mass Shift" value="0.1" type="float" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
86 <param name="isotope_correction" type="boolean" label="Isotope Correctoin" help="" truevalue="true" falsevalue="false" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
87 <param name="do_normalization" type="boolean" label="Normalize" help="" truevalue="true" falsevalue="false" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
88 </inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
89 <outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
90 <data format="consensusxml" name="out" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
91 </outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
92 <help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
93 **What it does**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
94
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
95 Extract the iTRAQ reporter ion intensities (4plex or 8plex) from raw MS2 data, does isotope corrections and stores the resulting quantitation as consensusXML, where each consensus centroid corresponds to one iTRAQ MS2 scan (e.g., HCD). The position of the centroid is the precursor position, its sub-elements are the channels (thus having m/z's of 113-121).
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
96
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
97 Isotope correction is done using non-negative least squares (NNLS), i.e.,
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
98
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
99 Minimize ||Ax - b||, subject to x >= 0, where b is the vector of observed reporter intensities (with 'contaminating' isotope species), A is a correction matrix (as supplied by the manufacturer AB Sciex) and x is the desired vector of corrected (real) reporter intensities. Other software solves this problem using an inverse matrix multiplication, but this can yield entries in x which are negative. In a real sample, this solution cannot possibly be true, so usually negative values (= negative reporter intensities) are set to 0. However, a negative result usually means, that noise was not accounted for thus we use NNLS to get a non-negative solution, without the need to truncate negative values. In (the usual) case that inverse matrix multiplication yields only positive values, our NNLS will give the exact same optimal solution.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
100
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
101 The correction matrices can be found (and changed) in the INI file. However, these matrices for both 4plex and 8plex are now stable, and every kit delivered should have the same isotope correction values. Thus, there should be no need to change them, but feel free to compare the values in the INI file with your kit's Certificate.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
102
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
103 After this quantitation step, you might want to annotate the consensus elements with the respective identifications, obtained from an identification pipeline. Note that quantification is solely on peptide level at this stage. In order to obtain protein quantifications, you can try TextExporter to obtain a simple text format which you can feed to other software tools (e.g., R), or you can try ProteinQuantifier.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
104
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
105
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
106 **Citation**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
107
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
108 For the underlying tool, please cite ``Marc Sturm, Andreas Bertsch, Clemens Gröpl, Andreas Hildebrandt, Rene Hussong, Eva Lange, Nico Pfeifer, Ole Schulz-Trieglaff, Alexandra Zerck, Knut Reinert, and Oliver Kohlbacher, 2008. OpenMS – an Open-Source Software Framework for Mass Spectrometry. BMC Bioinformatics 9: 163. doi:10.1186/1471-2105-9-163.`` and ``PepNovo: De Novo Peptide Sequencing via Probabilistic Network Modeling. Frank, A. and Pevzner, P. Analytical Chemistry 77:964-973, 2005.``.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
109
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
110 If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
111 </help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
112 </tool>