annotate protein_quantifier.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
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
1 <tool id="openms_protein_quantifier" version="0.1.0" name="Protein Quantifier">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
2 <description>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
3 Compute peptide and protein abundances from annotated feature/consensus maps.
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 openms_wrapper.py --executable 'ProteinQuantifier' --config $config
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
12 </command>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
13 <configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
14 <configfile name="config">[simple_options]
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
15 in=$map_input
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
16 #if $protein_prophet.use
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
17 protxml=$protxml
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
18 #end if
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
19 out=$protein_output
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
20 peptide_out=$peptide_output
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
21 top=$top
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
22 format!quoting=none
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
23 </configfile>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
24 </configfiles>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
25 <inputs>
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
26 <conditional name="type">
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
27 <param name="input_type" type="select" label="Input Type">
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
28 <option value="featurexml">Features (FeatureXML)</option>
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
29 <option value="consensusxml">Consensus (ConsensusXML)</option>
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
30 </param>
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
31 <when value="featurexml">
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
32 <param format="featurexml" name="map_input" type="data" label="Input Features" />
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
33 </when>
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
34 <when value="consensusxml">
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
35 <param format="consensusxml" name="map_input" type="data" label="Input Consensus" />
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
36 </when>
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
37 </conditional>
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
38 <conditional name="protein_prophet">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
39 <param name="use" label="Use ProteinProphet Results (converted to idXML)" help="For information about indistinguishable proteins." type="boolean" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
40 <when value="false">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
41 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
42 <when value="true">
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
43 <param name="protxml" label="Protein/Peptide Identifications Input" type="data" format="idxml" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
44 </when>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
45 </conditional>
4
1183846e70a1 Uploaded
galaxyp
parents: 2
diff changeset
46 <param name="top" label="Top" value="3" type="integer" help="Calculate protein abundance from this number of proteotypic peptides (most abundant first; '0' for all) (default: '3' min: '0')" />
2
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
47 </inputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
48 <outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
49 <data format="tabular" name="protein_output" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
50 <data format="tabular" name="peptide_output" />
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
51 </outputs>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
52 <help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
53 **What it does**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
54
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
55 Quantification is based on the intensity values of the features in the input. Feature intensities are first accumulated to peptide abundances, according to the peptide identifications annotated to the features/feature groups. Then, abundances of the peptides of a protein are averaged to compute the protein abundance.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
56
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
57 The peptide-to-protein step uses the (e.g. 3) most abundant proteotypic peptides per protein to compute the protein abundances. This is a general version of the "top 3 approach" (but only for relative quantification) described in:
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
58 Silva et al.: Absolute quantification of proteins by LCMSE: a virtue of parallel MS acquisition (Mol. Cell. Proteomics, 2006, PMID: 16219938).
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
59
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
60 Only features/feature groups with unambiguous peptide annotation are used for peptide quantification, and generally only proteotypic peptides (i.e. those matching to exactly one protein) are used for protein quantification. As an exception to this rule, if ProteinProphet results for the whole sample set are provided with the protxml option, or are already included in a featureXML input, also groups of indistinguishable proteins will be quantified. The reported quantity then refers to the total for the whole group.
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
61
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
62 Peptide/protein IDs from multiple identification runs can be handled, but will not be differentiated (i.e. protein accessions for a peptide will be accumulated over all identification runs).
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
63
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
64 Peptides with the same sequence, but with different modifications are quantified separately on the peptide level, but treated as one peptide for the protein quantification (i.e. the contributions of differently-modified variants of the same peptide are accumulated).
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
65
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
66 **Citation**
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
67
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
68 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.``
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
69 and ``Weisser et al.: An automated pipeline for high-throughput label-free quantitative proteomics (J. Proteome Res., 2013, PMID: 23391308). doi:10.1021/pr300992u``
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
70
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
71 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
72 </help>
cf0d72c7b482 Update.
galaxyp
parents:
diff changeset
73 </tool>