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
|
<HTML>
<HEAD>
<TITLE>SpecLibCreator</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> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<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">SpecLibCreator </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>creates with given data a .MSP format spectral library.</p>
<p>Information file should have the following information: peptide, retention time, measured weight, charge state. Extra information is allowed.</p>
<dl class="experimental"><dt><b><a class="el" href="experimental.html#_experimental000028">Experimental classes:</a></b></dt><dd>This Utility is not well tested and some features might not work as expected.</dd></dl>
<p><b>The command line parameters of this tool are:</b> </p>
<pre class="fragment">
SpecLibCreator -- Creates an MSP formatted spectral library.
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976
Usage:
SpecLibCreator <options>
Options (mandatory options marked with '*'):
-info <file>* Holds id, peptide, retention time etc. (valid formats: 'csv')
-itemseperator <char> Seperator between items. e.g. , (default: ',')
-itemenclosed <bool> 'true' or 'false' if true every item is enclosed e.g. '$peptide$,$run$... (default:
'false' valid: 'true', 'false')
-spec <file>* Spectra (valid formats: 'mzData', 'mzXML')
-out <file>* Output MSP formated spectra library (valid formats: 'msp')
Common UTIL options:
-ini <file> Use the given TOPP INI file
-threads <n> Sets the number of threads allowed to be used by the TOPP tool (default: '1')
-write_ini <file> 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">+SpecLibCreator</span><span class="node_description">Creates an MSP formatted spectral library.</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 'SpecLibCreator'</span></div>
<div class="item"><span class="item_name item_required" style="padding-left:24px;">info</span><span class="item_value"></span>
<span class="item_description">Holds id, peptide, retention time etc.</span><span class="item_tags">input file</span><span class="item_restrictions">*.csv</span></div> <div class="item"><span class="item_name" style="padding-left:24px;">itemseperator</span><span class="item_value">,</span>
<span class="item_description"> Seperator between items. e.g. ,</span><span class="item_tags"></span><span class="item_restrictions"> </span></div> <div class="item"><span class="item_name" style="padding-left:24px;">itemenclosed</span><span class="item_value">false</span>
<span class="item_description">'true' or 'false' if true every item is enclosed e.g. '$peptide$,$run$...</span><span class="item_tags"></span><span class="item_restrictions">true,false</span></div> <div class="item"><span class="item_name item_required" style="padding-left:24px;">spec</span><span class="item_value"></span>
<span class="item_description">spectra</span><span class="item_tags">input file</span><span class="item_restrictions">*.mzData,*.mzXML</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 MSP formated spectra library</span><span class="item_tags">output file</span><span class="item_restrictions">*.msp</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>
|