File: UTILS_Digestor.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 (88 lines) | stat: -rw-r--r-- 7,829 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
<HTML>
<HEAD>
<TITLE>Digestor</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">Digestor </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Digests a protein database in-silico. </p>
<center></center><center><table class="doxtable">
<tr>
<td align="center" bgcolor="#EBEBEB">pot. predecessor tools  </td><td valign="middle" rowspan="2"><img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> Digestor <img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> </td><td align="center" bgcolor="#EBEBEB">pot. successor tools   </td></tr>
<tr>
<td valign="middle" align="center" rowspan="1">none (FASTA input)  </td><td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_IDFilter.html">IDFilter</a> (peptide blacklist)  </td></tr>
</table>
</center><p>This application is used to digest a protein database to get all peptides given a cleavage enzyme. At the moment only trypsin is supported.</p>
<p>The output can be used as a blacklist filter input to <a class="el" href="TOPP_IDFilter.html">IDFilter</a>, to remove certain peptides.</p>
<p><b>The command line parameters of this tool are:</b> </p>
<pre class="fragment">
Digestor -- Digests a protein database in-silico.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976

Usage:
  Digestor &lt;options&gt;

Options (mandatory options marked with '*'):
  -in &lt;file&gt;*                 Input file (valid formats: 'fasta')
  -out &lt;file&gt;*                Output file (peptides) (valid formats: 'idXML', 'fasta')
  -out_type &lt;type&gt;            Set this if you cannot control the filename of 'out', e.g., in TOPPAS. (valid: 
                              'idXML', 'fasta')
  -missed_cleavages &lt;number&gt;  The number of allowed missed cleavages (default: '1' min: '0')
  -min_length &lt;number&gt;        Minimum length of peptide (default: '6')
  -max_length &lt;number&gt;        Maximum length of peptide (default: '40')
  -enzyme &lt;string&gt;            The type of digestion enzyme (default: 'Trypsin' valid: 'Trypsin', 'none')
                              
Common UTIL 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">+Digestor</span><span class="node_description">Digests a protein database in-silico.</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 'Digestor'</span></div>
      <div class="item"><span class="item_name item_required" style="padding-left:24px;">in</span><span class="item_value"></span>
<span class="item_description">input file</span><span class="item_tags">input file</span><span class="item_restrictions">*.fasta</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">out</span><span class="item_value"></span>
<span class="item_description">Output file (peptides)</span><span class="item_tags">output file</span><span class="item_restrictions">*.idXML,*.fasta</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">out_type</span><span class="item_value"></span>
<span class="item_description">Set this if you cannot control the filename of 'out', e.g., in TOPPAS.</span><span class="item_tags"></span><span class="item_restrictions">idXML,fasta</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">missed_cleavages</span><span class="item_value">1</span>
<span class="item_description">The number of allowed missed cleavages</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;">min_length</span><span class="item_value">6</span>
<span class="item_description">Minimum length of peptide</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">max_length</span><span class="item_value">40</span>
<span class="item_description">Maximum length of peptide</span><span class="item_tags"></span><span class="item_restrictions"> </span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">enzyme</span><span class="item_value">Trypsin</span>
<span class="item_description">The type of digestion enzyme</span><span class="item_tags"></span><span class="item_restrictions">Trypsin,none</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>
 </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>