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

« back to all changes in this revision

Viewing changes to doc/html/TOPPAS_examples.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:
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>Examples</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">Examples </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><p>The following sections explain the example pipelines TOPPAS comes with. You can open them by selecting <em>File</em> &gt; <em>Open</em> <em>example</em> <em>file</em>. All input files and parameters are already specified, so you can just hit <em>Pipeline</em> &gt; <em>Run</em> (or press <em>F5</em>) and see what happens.</p>
 
24
<h1><a class="anchor" id="TOPPAS_peak_picking_example"></a>
 
25
Profile data processing</h1>
 
26
<p>The file <em>peakpicker_tutorial.toppas</em> contains a simple pipeline representing a common use case: starting with profile data, the noise is eliminated and the baseline is subtracted. Then, PeakPickerWavelet is used to find all peaks in the noise-filtered and baseline-reduced profile data. This workflow is also described in the section <a class="el" href="TOPP_example_signalprocessing.html">Profile data processing</a>. The individual steps are explained in more detail in the TOPPView tutorial: <a class="el" href="TOPPView_smoothing.html">Smoothing raw data</a>, <a class="el" href="TOPPView_baseline_reduction.html">Substracting a baseline from a spectrum</a>, and <a class="el" href="TOPPView_peakpicking.html">Picking peaks</a>.</p>
 
27
<div class="image">
 
28
<img src="TOPPAS_example_profile_data_processing.png" alt="TOPPAS_example_profile_data_processing.png"/>
 
29
</div>
 
30
 <h1><a class="anchor" id="TOPPAS_id_example"></a>
 
31
Identification of E. coli peptides</h1>
 
32
<p>This section describes an example identification pipeline contained in the example directory, <em>Ecoli_Identification.toppas</em>. It is shipped together with a reduced example mzML file containing 139 MS2 spectra from an E. coli run on an Orbitrap instrument as well as an E. coli target-decoy database.</p>
 
33
<p>We use the search engine OMSSA (Geer et al., 2004) for peptide identification. Therefore, OMSSA must be installed and the path to the OMSSA executable (omssacl) must be set in the parameters of the OMSSAAdapter node.</p>
 
34
<ul>
 
35
<li>Node #1 accepts mzML files containing MS2 spectra.</li>
 
36
<li>Node #2 provides the database and is set to "recycling mode" to allow the database to be reused when there is more than one input file in node #1.</li>
 
37
<li>OMSSAAdapter calls OMSSA which performs the actual search.</li>
 
38
<li>PeptideIndexer annotates for each search result whether it is a target or a decoy hit.</li>
 
39
<li>FalseDiscoveryRate computes q-values for the IDs.</li>
 
40
<li>Finally, IDFilter selects only those IDs with a q-value of less than 1%.</li>
 
41
</ul>
 
42
<div class="image">
 
43
<img src="TOPPAS_Ecoli_Identification.png" alt="TOPPAS_Ecoli_Identification.png"/>
 
44
</div>
 
45
 <p>Extensions to this pipeline would be to do the annotation of the spectra with multiple search engines and combine the results afterwards, using the ConsensusID TOPP tool.</p>
 
46
<p>The results may be exported using the TextExporter tool, for further analysis with different tools.</p>
 
47
<h1><a class="anchor" id="TOPPAS_quant_example"></a>
 
48
Quantitation of BSA runs</h1>
 
49
<p>The simple pipeline described in this section (<em>BSA_Quantitation.toppas</em>) can be used to quantify peptides that occur on different runs. The example dataset contains three different bovine serum albumin (BSA) runs. First, FeatureFinderCentroided is called since the dataset is centroided. The results of the feature finding are then annotated with (existing) identification results. For convenience, we provide these search results from OMSSA with peptides with an FDR of 5% in the BSA directory.</p>
 
50
<div class="image">
 
51
<img src="TOPPAS_BSA_Quantitation.png" alt="TOPPAS_BSA_Quantitation.png"/>
 
52
</div>
 
53
 <p>Identifications are mapped to features by the IDMapper. The last step is performed by FeatureLinkerUnlabeled which links corresponding features. The results can be used to calculate ratios, for example. The data could also be exported to a text based format using the TextExporter for further processing (e.g., in Microsoft Excel).</p>
 
54
<p>The results can be opened in TOPPView. The next figures show the results in 2D and 3D view, together with the feature intermediate results. One can see that the intensities and retention times are slightly different between the runs. To correct for retention times shift, a map alignment could be done, either on the spectral data or on the feature data.</p>
 
55
<div class="image">
 
56
<img src="TOPPAS_BSA_results_2d.png" alt="TOPPAS_BSA_results_2d.png"/>
 
57
</div>
 
58
 <div class="image">
 
59
<img src="TOPPAS_BSA_results_3d.png" alt="TOPPAS_BSA_results_3d.png"/>
 
60
</div>
 
61
 <h1><a class="anchor" id="TOPPAS_merger_example"></a>
 
62
Merger and Collect nodes</h1>
 
63
<p>The following example is actually not a useful workflow but is supposed to demonstrate how merger and collector nodes can be used in a pipeline. Have a look at <em>merger_tutorial.toppas:</em> </p>
 
64
<div class="image">
 
65
<img src="TOPPAS_example_merger.png" alt="TOPPAS_example_merger.png"/>
 
66
</div>
 
67
 <p>As its name suggests, a merger merges its incoming file lists, i.e., files of all incoming egdes are appended into new lists (which have as many elements as the merger has incoming connections). All tools this merger has outgoing connections to are called with these merged lists as input files. All incoming connections should pass the same number of files (unless the corresponding preceding tool is in recycling mode).</p>
 
68
<p>A collector node, on the other hand, waits for all rounds to finish before concatenating all files from all incoming connections into one single list. It then calls the next tool with this list of files as input. This will happen exactly once during the entire pipeline run.</p>
 
69
<p>In order to track what is happening, you can just open the example file and run it. When the pipeline execution has finished, have a look at all input and output files (e.g., select <em>Open</em> <em>in</em> <em>TOPPView</em> in the context menu of the input/output nodes). The input files are named rt_1.mzML, rt_2.mzML, ... and each contains a single spectrum with RT as indicated by the filename, so you can easily see which files have been merged together. </p>
 
70
</div></div><!-- contents -->
 
71
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
72
<TABLE width="100%" border="0">
 
73
<TR>
 
74
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
75
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:25 using doxygen 1.8.5</font></TD>
 
76
</TR>
 
77
</TABLE>
 
78
</BODY>
 
79
</HTML>