← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/UTILS_QCImporter.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_QCImporter.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>QCImporter</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">QCImporter </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><p>This application is used embed tables or pictures generated externally as attachments to existing quality parameters in the targeted run/set meant to have attachments. If no quality parameter is present an empty value one will be generated with the name of "default set name"/"default mzML file".</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"/> QCEmbedder <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="1"><a class="el" href="UTILS_QCExporter.html">QCExporter</a>  </td><td valign="middle" align="center" rowspan="1"><a class="el" href="UTILS_QCMerger.html">QCMerger</a>   </td></tr>
 
29
<tr>
 
30
<td valign="middle" align="center" rowspan="1"><a class="el" href="TOPP_XTandemAdapter.html">XTandemAdapter</a>  </td><td valign="middle" align="center" rowspan="1"><a class="el" href="UTILS_QCShrinker.html">QCShrinker</a>   </td></tr>
 
31
</table>
 
32
</center><p>If there is additional data from external tools in tabular format containing additional quality control parameter (qp) to runs or sets, or even new runs, in the qcml file at <code>in</code> it can be imported to complete the qcml file, written subsequently to <code>out</code>.</p>
 
33
<ul>
 
34
<li><code>table</code> The table containing the additional qp values in the columns. First row is considered containing the header. The target run or set names/ids are indicated by column "raw data file", so each row after the header will contain the values of qps for that run.</li>
 
35
<li><code>mapping</code> The mapping of the table header to the according qp cvs, also in csv format. The first row is considered containing the headers as in the table. The second row is considered the according qp cv accessions.</li>
 
36
</ul>
 
37
<p><b>The command line parameters of this tool are:</b> </p>
 
38
<pre class="fragment">
 
39
QCImporter -- Imports tables with quality control parameters into qcml files.
 
40
Version: 1.11.1 Nov 14 2013, 11:18:15, Revision: 11976
 
41
 
 
42
Usage:
 
43
  QCImporter &lt;options&gt;
 
44
 
 
45
Options (mandatory options marked with '*'):
 
46
  -in &lt;file&gt;         Input qcml file (valid formats: 'qcML')
 
47
  -table &lt;file&gt;*     The table containing the additional qp values in the columns. First row is considered 
 
48
                     containing the header. The target run or set names/ids are indicated by column "raw data
 
49
                     file", so each row after the header will contain the values of qps for that run. (valid
 
50
                     formats: 'csv')
 
51
  -mapping &lt;file&gt;*   The mapping of the table header to the according qp cvs, also in csv format. The first 
 
52
                     row is considered containing the headers as in the table. The second row is considered
 
53
                     the according qp cv accessions. (valid formats: 'csv')
 
54
  -out &lt;file&gt;*       Output extended qcML file (valid formats: 'qcML')
 
55
                     
 
56
Common UTIL options:
 
57
  -ini &lt;file&gt;        Use the given TOPP INI file
 
58
  -threads &lt;n&gt;       Sets the number of threads allowed to be used by the TOPP tool (default: '1')
 
59
  -write_ini &lt;file&gt;  Writes the default configuration file
 
60
  --help             Shows options
 
61
  --helphelp         Shows all options (including advanced)
 
62
 
 
63
</pre><p> <b>INI file documentation of this tool:</b> <div class="ini_global">
 
64
<div class="legend">
 
65
<b>Legend:</b><br>
 
66
 <div class="item item_required">required parameter</div>
 
67
 <div class="item item_advanced">advanced parameter</div>
 
68
</div>
 
69
  <div class="node"><span class="node_name">+QCImporter</span><span class="node_description">Imports tables with quality control parameters into qcml files.</span></div>
 
70
    <div class="item item_advanced"><span class="item_name" style="padding-left:16px;">version</span><span class="item_value">1.11.1</span>
 
71
<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 'QCImporter'</span></div>
 
72
      <div class="item"><span class="item_name" style="padding-left:24px;">in</span><span class="item_value"></span>
 
73
<span class="item_description">Input qcml file</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;">table</span><span class="item_value"></span>
 
74
<span class="item_description">The table containing the additional qp values in the columns. First row is considered containing the header. The target run or set names/ids are indicated by column "raw data file", so each row after the header will contain the values of qps for that run.</span><span class="item_tags">input file</span><span class="item_restrictions">*.csv</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">mapping</span><span class="item_value"></span>
 
75
<span class="item_description">The mapping of the table header to the according qp cvs, also in csv format. The first row is considered containing the headers as in the table. The second row is considered the according qp cv accessions.</span><span class="item_tags">input file</span><span class="item_restrictions">*.csv</span></div>      <div class="item"><span class="item_name item_required" style="padding-left:24px;">out</span><span class="item_value"></span>
 
76
<span class="item_description">Output extended qcML file</span><span class="item_tags">output file</span><span class="item_restrictions">*.qcML</span></div>      <div class="item item_advanced"><span class="item_name" style="padding-left:24px;">log</span><span class="item_value"></span>
 
77
<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>
 
78
<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>
 
79
<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>
 
80
<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>
 
81
<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>
 
82
 </div></div><!-- contents -->
 
83
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
84
<TABLE width="100%" border="0">
 
85
<TR>
 
86
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
87
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
 
88
</TR>
 
89
</TABLE>
 
90
</BODY>
 
91
</HTML>