~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/TOPP_OpenSwathConfidenceScoring.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>OpenSwathConfidenceScoring</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
</div><!-- top -->
 
18
<div class="header">
 
19
  <div class="headertitle">
 
20
<div class="title">OpenSwathConfidenceScoring </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><p>Computes confidence scores for <a class="el" href="namespaceOpenSwath.html">OpenSwath</a> results.</p>
 
24
<center> <table class="doxtable">
 
25
<tr>
 
26
<td align="center" bgcolor="#EBEBEB">potential predecessor tools  </td><td valign="middle" rowspan="2"><img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> OpenSwathConfidenceScoring <img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> </td><td align="center" bgcolor="#EBEBEB">potential successor tools   </td></tr>
 
27
<tr>
 
28
<td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_OpenSwathAnalyzer.html">OpenSwathAnalyzer</a>  </td><td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_OpenSwathFeatureXMLToTSV.html">OpenSwathFeatureXMLToTSV</a>   </td></tr>
 
29
</table>
 
30
</center><p>This is an implementation of the SRM scoring algorithm described in:</p>
 
31
<p>Malmstroem, L.; Malmstroem, J.; Selevsek, N.; Rosenberger, G. &amp; Aebersold, R.:<br/>
 
32
<a href="http://dx.doi.org/10.1021/pr200844d">Automated workflow for large-scale selected reaction monitoring experiments.</a><br/>
 
33
J. Proteome Res., 2012, 11, 1644-1653</p>
 
34
<p>It has been adapted for the scoring of <a class="el" href="namespaceOpenSwath.html">OpenSwath</a> results.</p>
 
35
<p>The algorithm compares SRM/MRM features (peak groups) to assays and computes scores for the agreements. Every feature is compared not only to the "true" assay that was used to acquire the corresponding ion chromatograms, but also to a number (parameter <code>decoys</code>) of unrelated - but real - assays selected at random from the assay library (parameter <code>lib</code>). This serves to establish a background distribution of scores, against which the significance of the "true" score can be evaluated. The final confidence value of a feature is the local false discovery rate (FDR), calculated as the fraction of decoy assays that score higher than the "true" assay against the feature. In the output feature map, every feature is annotated with its local FDR in the meta value "local_FDR" (a "userParam" element in the featureXML), and its overall quality is set to "1 - local_FDR".</p>
 
36
<p>The agreement of a feature and an assay is assessed based on the difference in retention time (RT) and on the deviation of relative transition intensities. The score <em>S</em> is computed using a binomial generalized linear model (GLM) of the form:</p>
 
37
<p class="formulaDsp">
 
38
<img class="formulaDsp" alt="\[ S = \frac{1}{1 + \exp(-(a + b \cdot \Delta_{RT}^2 + c \cdot d_{int}))} \]" src="form_92.png"/>
 
39
</p>
 
40
<p>The meanings of the model terms are as follows:</p>
 
41
<p><img class="formulaInl" alt="$ \Delta_{RT} $" src="form_93.png"/>: Observed retention times are first mapped to the scale of the assays (parameter <code>trafo</code>), then all RTs are scaled to the range 0 to 100 (based on the lowest/highest RT in the assay library). <img class="formulaInl" alt="$ \Delta_{RT} $" src="form_93.png"/> is the absolute difference of the scaled RTs; note that this is squared in the scoring model.</p>
 
42
<p><img class="formulaInl" alt="$ d_{int} $" src="form_94.png"/>: To compute the intensity distance, the <em>n</em> (advanced parameter <code>transitions</code>) most intensive transitions of the feature are selected. For comparing against the "true" assay, the same transitions are considered; otherwise, the same number of most intensive transitions from the decoy assay. Transition intensities are scaled to a total of 1 per feature/assay and are ordered by the product (Q3) m/z value. Then the Manhattan distance of the intensity vectors is calculated (Malmstroem et. al used the RMSD instead, which has been replaced here to be independent of the number of transitions).</p>
 
43
<p><img class="formulaInl" alt="$ a, b, c $" src="form_95.png"/>: Model coefficients, stored in the advanced parameters <code>GLM:intercept</code>, <code>GLM:delta_rt</code>, and <code>GLM:dist_int</code>. The default values were estimated based on the training dataset used in the Malmstroem et al. study, reprocessed with the <a class="el" href="namespaceOpenSwath.html">OpenSwath</a> pipeline.</p>
 
44
<p>In addition to the local FDRs, the scores of features against their "true" assays are recorded in the output - in the meta value "GLM_score" of the respective feature.</p>
 
45
<p><b>The command line parameters of this tool are:</b> </p>
 
46
<pre class="fragment">
 
47
OpenSwathConfidenceScoring -- Compute confidence scores for OpenSwath results
 
48
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976
 
49
 
 
50
Usage:
 
51
  OpenSwathConfidenceScoring &lt;options&gt;
 
52
 
 
53
Options (mandatory options marked with '*'):
 
54
  -in &lt;file&gt;*            Input file (OpenSwath results) (valid formats: 'featureXML')
 
55
  -lib &lt;file&gt;*           Assay library (valid formats: 'traML')
 
56
  -out &lt;file&gt;*           Output file (results with confidence scores) (valid formats: 'featureXML')
 
57
  -trafo &lt;file&gt;          Retention time transformation (valid formats: 'trafoXML')
 
58
  -decoys &lt;number&gt;       Number of decoy assays to select from the library for every true assay (0 for "all")
 
59
                         (default: '1000' min: '0')
 
60
  -transitions &lt;number&gt;  Number of transitions per feature to consider (highest intensities first; 0 for "all
 
61
                         ") (default: '6' min: '0')
 
62
                         
 
63
Common TOPP options:
 
64
  -ini &lt;file&gt;            Use the given TOPP INI file
 
65
  -threads &lt;n&gt;           Sets the number of threads allowed to be used by the TOPP tool (default: '1')
 
66
  -write_ini &lt;file&gt;      Writes the default configuration file
 
67
  --help                 Shows options
 
68
  --helphelp             Shows all options (including advanced)
 
69
 
 
70
</pre><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
 
71
<div class="legend">
 
72
<b>Legend:</b><br>
 
73
 <div class="item item_required">required parameter</div>
 
74
 <div class="item item_advanced">advanced parameter</div>
 
75
</div>
 
76
  <div class="node"><span class="node_name">+OpenSwathConfidenceScoring</span><span class="node_description">Compute confidence scores for OpenSwath results</span></div>
 
77
    <div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
 
78
<span class="item_description">Version of the tool that generated this parameters file.</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>    <div class="node"><span class="node_name">++1</span><span class="node_description">Instance '1' section for 'OpenSwathConfidenceScoring'</span></div>
 
79
      <div class="item"><span class="item_name item_required" style="padding-left:24px;">in</span><span class="item_value"></span>
 
80
<span class="item_description">Input file (OpenSwath results)</span><span class="item_tags">input file</span><span class="item_restrictions">*.featureXML</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">lib</span><span class="item_value"></span>
 
81
<span class="item_description">Assay library</span><span class="item_tags">input file</span><span class="item_restrictions">*.traML</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">out</span><span class="item_value"></span>
 
82
<span class="item_description">Output file (results with confidence scores)</span><span class="item_tags">output file</span><span class="item_restrictions">*.featureXML</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">trafo</span><span class="item_value"></span>
 
83
<span class="item_description">Retention time transformation</span><span class="item_tags">input file</span><span class="item_restrictions">*.trafoXML</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">decoys</span><span class="item_value">1000</span>
 
84
<span class="item_description">Number of decoy assays to select from the library for every true assay (0 for "all")</span><span class="item_tags"></span><span class="item_restrictions">0:&#8734;</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">transitions</span><span class="item_value">6</span>
 
85
<span class="item_description">Number of transitions per feature to consider (highest intensities first; 0 for "all")</span><span class="item_tags"></span><span class="item_restrictions">0:&#8734;</span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">log</span><span class="item_value"></span>
 
86
<span class="item_description">Name of log file (created only when specified)</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">debug</span><span class="item_value">0</span>
 
87
<span class="item_description">Sets the debug level</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">threads</span><span class="item_value">1</span>
 
88
<span class="item_description">Sets the number of threads allowed to be used by the TOPP tool</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">no_progress</span><span class="item_value">false</span>
 
89
<span class="item_description">Disables progress logging to command line</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">test</span><span class="item_value">false</span>
 
90
<span class="item_description">Enables the test mode (needed for internal use only)</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div>      <div class="node"><span class="node_name">+++GLM</span><span class="node_description">Parameters of the binomial GLM</span></div>
 
91
        <div class="item item_advanced"><span class="item_name" style="padding-left:32px;">intercept</span><span class="item_value">3.87333466</span>
 
92
<span class="item_description">Intercept term</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>        <div class="item item_advanced"><span class="item_name" style="padding-left:32px;">delta_rt</span><span class="item_value">-0.02898629</span>
 
93
<span class="item_description">Coefficient of retention time difference</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>        <div class="item item_advanced"><span class="item_name" style="padding-left:32px;">dist_int</span><span class="item_value">-7.75880768</span>
 
94
<span class="item_description">Coefficient of intensity distance</span><span class="item_tags"></span><span class="item_restrictions"> </span></div></div>
 
95
 </div></div><!-- contents -->
 
96
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
97
<TABLE width="100%" border="0">
 
98
<TR>
 
99
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
100
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
 
101
</TR>
 
102
</TABLE>
 
103
</BODY>
 
104
</HTML>