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
|
<HTML>
<HEAD>
<TITLE>Quickstart guide to OpenMS/TOPP</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">Quickstart guide to OpenMS/TOPP </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>If you want a short glance at the most important concepts and how to use tools quickly, this guide is right for you. You should still read the whole documentation at some point though.</p>
<h1><a class="anchor" id="basic_Concepts"></a>
Basic Concepts of OpenMS/TOPP</h1>
<p><b>OpenMS</b>: The name of our library, which contains the algorithms. You cannot use this directly, unless you are a programmer.<br/>
<b>TOPPView:</b> View and explore LC-MS data, alignments, groups, peptide identifications and more!<br/>
<b>TOPPAS:</b> A graphical workflow design tool, which allows to create pipelines from all TOPP tools (and UTILS).<br/>
<b>TOPP</b> <b>tools:</b> A set of command line tools, each of which is a building block of an analysis pipeline. These tools chained together in a way that fits the requirements of the user. Accessible from a command prompt/shell or via TOPPAS. See also: <a class="el" href="TOPP_tutorial.html">TOPP tutorial</a> and <a class="el" href="TOPP_documentation.html">TOPP documentation</a> <br/>
<b>UTILS:</b> Similar to TOPP tools, but with more supporting character, which you'd rarely use in a productive pipeline - but rather during pipeline construction or parameter optimization. See also: <a class="el" href="UTILS_documentation.html">UTILS documentation</a></p>
<h1><a class="anchor" id="run_tool"></a>
How to run a tool</h1>
<p>We'd recommend using TOPPAS. A good start are the example pipelines (see "File" –> "Open example file" within TOPPAS). In parallel you can read the documentation of the tools (see <a class="el" href="TOPP_tutorial.html">TOPP tutorial</a>, <a class="el" href="TOPP_documentation.html">TOPP documentation</a>) and the one of TOPPAS (<a class="el" href="TOPPAS_tutorial.html">TOPPAS tutorial</a>).</p>
<p>Alternatively, you can use the command line and call tools directly. In this case you'll probably want to use some type of shell script for automation.</p>
<h1><a class="anchor" id="parameters"></a>
Adapting your pipeline parameters</h1>
<p>The default parameters of each tool can usually be tweaked to fit your data and improve results.</p>
<h2><a class="anchor" id="parameters_where"></a>
Where do you change them?!</h2>
<p><b>TOPPAS:</b> Double-click the node of which you want to change the parameters. A short docu for each parameter will show up once you select it. All parameters which would be available on the command line and in the INI file are shown here as well.</p>
<p><b>Command</b> <b>line:</b> Very basic parameters can be set on the command line, e.g. <code>FileFilter -rt 1000:2000 ....</code>.<br/>
Doing this for all parameters would create a very long list, thus, we use so-called ".ini" files to provide full parameter sets to TOPP tools. If no INI file is given, default parameters are used. To get a default .ini use </p>
<p><code><tool> -write_ini <file></code> </p>
<p>e.g. <br/>
<code>FileFilter -write_ini filefilter.ini</code> </p>
<p>Now, you can edit the INI file (which is a XML file) using our <a class="el" href="TOPP_INIFileEditor.html">INIFileEditor</a>, which is another GUI tool shipped with OpenMS and similar to the one build into TOPPAS.</p>
<h2><a class="anchor" id="parameters_feed"></a>
How do I feed the INI file to a tool?!</h2>
<p><b>TOPPAS:</b> Once you changed the parameters of a node and clicked "Ok", the parameters are in effect. Because they are part of the TOPPAS workflow, they are saved together with the workflow.</p>
<p><b>Command</b> <b>line:</b> Simply supply the INI file via the <code>-ini</code> flag, e.g., </p>
<p><code><tool> -ini <file></code> </p>
<p>e.g. <br/>
<code>FileFilter -ini filefilter.ini</code> </p>
<h2><a class="anchor" id="parameters_how"></a>
What parameters need changing and to what value?!</h2>
<p>This is tricky and its not possible to give a general answer. In general, you should read the tool description, change the parameters and compare the results using TOPPView if possible. If that does not help try the OpenMS mailing list and ask, but provide us with the details we need in order to help you (see <a href="www.openms.de/BUGS">www.openms.de/BUGS</a>). </p>
</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:25 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
