File: TOPP_RTPredict.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (105 lines) | stat: -rw-r--r-- 11,283 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<HTML>
<HEAD>
<TITLE>RTPredict</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">RTPredict </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This application is used to predict retention times for peptides or peptide separation.</p>
<p>This methods and applications of this model are described in several publications:</p>
<p>Nico Pfeifer, Andreas Leinenbach, Christian G. Huber and Oliver Kohlbacher Statistical learning of peptide retention behavior in chromatographic separations: A new kernel-based approach for computational proteomics. BMC Bioinformatics 2007, 8:468</p>
<p>Nico Pfeifer, Andreas Leinenbach, Christian G. Huber and Oliver Kohlbacher Improving Peptide Identification in Proteome Analysis by a Two-Dimensional Retention Time Filtering Approach J. Proteome Res. 2009, 8(8):4109-15</p>
<p>The input of this application is an svm model and an idXML file with peptide identifications. The svm model file is specified by the <b>svm_model</b> parameter in the command line or the ini file. This file should have been produced by the <a class="el" href="TOPP_RTModel.html">RTModel</a> application. <br/>
 For retention time prediction the peptide sequences are extracted from the idXML inputfile and passed to the svm. The svm then predicts retention times according to the trained model. The predicted retention times are stored as</p>
<div class="fragment"><div class="line">&lt;userParam name=<span class="stringliteral">&quot;predicted_retention_time&quot;</span> value=<span class="stringliteral">&quot;&lt;predicted retention time&gt;&quot;</span> /&gt;</div>
</div><!-- fragment --><p> inside the peptide entities in the idXML output file.</p>
<p>For separation prediction you have to specify two output file names. 'out_id:positive' is the filename of the peptides which are predicted to be collected by the column and 'out_id:negative' is the file of the predicted flowthrough peptides.</p>
<p>Retention time prediction and separation prediction cannot be combined!</p>
<p><b>The command line parameters of this tool are:</b> </p>
<pre class="fragment">
RTPredict -- Predicts retention times for peptides using a model trained by RTModel.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976

Usage:
  RTPredict &lt;options&gt;

Options (mandatory options marked with '*'):
  -in_id &lt;file&gt;                Peptides with precursor information (valid formats: 'idXML')
  -in_text &lt;file&gt;              Peptides as text-based file (valid formats: 'txt')

Output files in idXML format:
  -out_id:file &lt;file&gt;          Output file with peptide RT prediction (valid formats: 'idXML')
  -out_id:positive &lt;file&gt;      Output file in idXML format containing positive predictions (peptide separatio
                               n prediction - requires negative file to be present as well)
                               (valid formats: 'idXML')
  -out_id:negative &lt;file&gt;      Output file in idXML format containing negative predictions (peptide separatio
                               n prediction - requires positive file to be present as well)
                               (valid formats: 'idXML')

Output files in text format:
  -out_text:file &lt;file&gt;        Output file with predicted RT values (valid formats: 'csv')

  -svm_model &lt;file&gt;*           Svm model in libsvm format (can be produced by RTModel) (valid formats: 'txt')
  -total_gradient_time &lt;time&gt;  The time (in seconds) of the gradient (peptide RT prediction) (default: '1' 
                               min: '1e-05')
                               
Common TOPP options:
  -ini &lt;file&gt;                  Use the given TOPP INI file
  -threads &lt;n&gt;                 Sets the number of threads allowed to be used by the TOPP tool (default: '1')
  -write_ini &lt;file&gt;            Writes the default configuration file
  --help                       Shows options
  --helphelp                   Shows all options (including advanced)

</pre><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
<div class="legend">
<b>Legend:</b><br>
 <div class="item item_required">required parameter</div>
 <div class="item item_advanced">advanced parameter</div>
</div>
  <div class="node"><span class="node_name">+RTPredict</span><span class="node_description">Predicts retention times for peptides using a model trained by RTModel.</span></div>
    <div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
<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 'RTPredict'</span></div>
      <div class="item"><span class="item_name" style="padding-left:24px;">in_id</span><span class="item_value"></span>
<span class="item_description">peptides with precursor information</span><span class="item_tags">input file</span><span class="item_restrictions">*.idXML</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">in_text</span><span class="item_value"></span>
<span class="item_description">peptides as text-based file</span><span class="item_tags">input file</span><span class="item_restrictions">*.txt</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">svm_model</span><span class="item_value"></span>
<span class="item_description">svm model in libsvm format (can be produced by RTModel)</span><span class="item_tags">input file</span><span class="item_restrictions">*.txt</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">total_gradient_time</span><span class="item_value">1</span>
<span class="item_description">the time (in seconds) of the gradient (peptide RT prediction)</span><span class="item_tags"></span><span class="item_restrictions">1e-05:&#8734;</span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">max_number_of_peptides</span><span class="item_value">100000</span>
<span class="item_description">the maximum number of peptides considered at once (bigger number will lead to faster results but needs more memory).<br></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;">log</span><span class="item_value"></span>
<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>
<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>
<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>
<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>
<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">+++out_id</span><span class="node_description">Output files in idXML format</span></div>
        <div class="item"><span class="item_name" style="padding-left:32px;">file</span><span class="item_value"></span>
<span class="item_description">Output file with peptide RT prediction</span><span class="item_tags">output file</span><span class="item_restrictions">*.idXML</span></div>        <div class="item"><span class="item_name" style="padding-left:32px;">positive</span><span class="item_value"></span>
<span class="item_description">Output file in idXML format containing positive predictions (peptide separation prediction - requires negative file to be present as well)<br></span><span class="item_tags">output file</span><span class="item_restrictions">*.idXML</span></div>        <div class="item"><span class="item_name" style="padding-left:32px;">negative</span><span class="item_value"></span>
<span class="item_description">Output file in idXML format containing negative predictions (peptide separation prediction - requires positive file to be present as well)<br></span><span class="item_tags">output file</span><span class="item_restrictions">*.idXML</span></div>        <div class="item item_advanced"><span class="item_name" style="padding-left:32px;">rewrite_peptideidentification_rtmz</span><span class="item_value">false</span>
<span class="item_description">rewrites each peptideidentification's rt and mz from prediction and calculation (according to the best hit)</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div>      <div class="node"><span class="node_name">+++out_text</span><span class="node_description">Output files in text format</span></div>
        <div class="item"><span class="item_name" style="padding-left:32px;">file</span><span class="item_value"></span>
<span class="item_description">Output file with predicted RT values</span><span class="item_tags">output file</span><span class="item_restrictions">*.csv</span></div></div>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000035">Todo:</a></b></dt><dd>This need serious clean up! Combining certain input and output options will result in strange behaviour, especially when using text output/input. </dd></dl>
</div></div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>