← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/UTILS_QCMerger.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:
doc/html/UTILS_QCMerger.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>QCMerger</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">QCMerger </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><p>Merges two qcml files together.</p>
 
24
<center> <table class="doxtable">
 
25
<tr>
 
26
<td align="center" bgcolor="#EBEBEB">pot. predecessor tools  </td><td valign="middle" rowspan="3"><img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> QCCalculator <img class="formulaInl" alt="$ \longrightarrow $" src="form_91.png"/> </td><td align="center" bgcolor="#EBEBEB">pot. successor tools   </td></tr>
 
27
<tr>
 
28
<td valign="middle" align="center" rowspan="2"><a class="el" href="UTILS_QCCalculator.html">QCCalculator</a>   </td></tr>
 
29
<tr>
 
30
<td valign="middle" align="center" rowspan="1"><a class="el" href="UTILS_QCShrinker.html">QCShrinker</a>   </td></tr>
 
31
</table>
 
32
</center><p>The two or more given files (see parameter <code>in</code>) are merged. If a run/set exisits in several files, the qp of these are merged as well. Several runs from qcml files can be comprised in a set.</p>
 
33
<ul>
 
34
<li><code>setname</code> If the runs of the given input files are to be comprised in a set, this will be the name of the set.</li>
 
35
</ul>
 
36
<p>Output is in qcML format (see parameter <code>out</code>) which can be viewed directly in a modern browser (chromium, firefox).</p>
 
37
<p><b>The command line parameters of this tool are:</b> </p>
 
38
<pre class="fragment">
 
39
QCMerger -- Merges two qcml files together.
 
40
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976
 
41
 
 
42
Usage:
 
43
  QCMerger &lt;options&gt;
 
44
 
 
45
Options (mandatory options marked with '*'):
 
46
  -in &lt;files&gt;*       List of qcml files to be merged. (valid formats: 'qcML')
 
47
  -out &lt;file&gt;*       Output extended/reduced qcML file (valid formats: 'qcML')
 
48
  -setname &lt;string&gt;  Use only when all given qcml files belong to one set, which will be held under the given
 
49
                     name.
 
50
                     
 
51
Common UTIL options:
 
52
  -ini &lt;file&gt;        Use the given TOPP INI file
 
53
  -threads &lt;n&gt;       Sets the number of threads allowed to be used by the TOPP tool (default: '1')
 
54
  -write_ini &lt;file&gt;  Writes the default configuration file
 
55
  --help             Shows options
 
56
  --helphelp         Shows all options (including advanced)
 
57
 
 
58
</pre><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
 
59
<div class="legend">
 
60
<b>Legend:</b><br>
 
61
 <div class="item item_required">required parameter</div>
 
62
 <div class="item item_advanced">advanced parameter</div>
 
63
</div>
 
64
  <div class="node"><span class="node_name">+QCMerger</span><span class="node_description">Merges two qcml files together.</span></div>
 
65
    <div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
 
66
<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 'QCMerger'</span></div>
 
67
      <div class="item"><span class="item_name item_required" style="padding-left:24px;">in</span><span class="item_value">[]</span>
 
68
<span class="item_description">List of qcml files to be merged.</span><span class="item_tags">input file</span><span class="item_restrictions">*.qcML</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">out</span><span class="item_value"></span>
 
69
<span class="item_description">Output extended/reduced qcML file</span><span class="item_tags">output file</span><span class="item_restrictions">*.qcML</span></div>      <div class="item"><span class="item_name" style="padding-left:24px;">setname</span><span class="item_value"></span>
 
70
<span class="item_description">Use only when all given qcml files belong to one set, which will be held under the given name.</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>
 
71
<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>
 
72
<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>
 
73
<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>
 
74
<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>
 
75
<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>
 
76
 </div></div><!-- contents -->
 
77
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
78
<TABLE width="100%" border="0">
 
79
<TR>
 
80
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
81
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
 
82
</TR>
 
83
</TABLE>
 
84
</BODY>
 
85
</HTML>