annotate protein_quantifier.xml @ 2:cf0d72c7b482 draft

Update.

<tool id="openms_protein_quantifier" version="0.1.0" name="Protein Quantifier">
  <description>
    Compute peptide and protein abundances from annotated feature/consensus maps.
  </description>
  <macros>
    <import>macros.xml</import>
  </macros>
  <expand macro="stdio" />
  <expand macro="requires" />
  <command interpreter="python">
    openms_wrapper.py --executable 'ProteinQuantifier' --config $config
  </command>
  <configfiles>
    <configfile name="config">[simple_options]
in=$map_input
#if $protein_prophet.use
protxml=$protxml
#end if
out=$protein_output
peptide_out=$peptide_output
top=$top
format!quoting=none
</configfile>
  </configfiles>
  <inputs>
    <expand macro="map_input" />
    <conditional name="protein_prophet">
      <param name="use" label="Use ProteinProphet Results (converted to idXML)" help="For information about indistinguishable proteins." type="boolean" />
      <when value="false">
      </when>
      <when value="true">
        <param name="protxml" label="Protein/Peptide Identifications Input" type="data" format="idxml" />
      </when>
    </conditional>
    <param name="top" label="Top" value="0" type="integer" />
  </inputs>
  <outputs>
    <data format="tabular" name="protein_output" />
    <data format="tabular" name="peptide_output" />
  </outputs>
  <help>
**What it does**

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.

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:
Silva et al.: Absolute quantification of proteins by LCMSE: a virtue of parallel MS acquisition (Mol. Cell. Proteomics, 2006, PMID: 16219938).

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.

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).

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).

**Citation**

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 ``Weisser et al.: An automated pipeline for high-throughput label-free quantitative proteomics (J. Proteome Res., 2013, PMID: 23391308). doi:10.1021/pr300992u``

If you use this tool in Galaxy, please cite Chilton J, et al. https://bitbucket.org/galaxyp/galaxyp-toolshed-openms
  </help>
</tool>