← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/TOPP_example_handling.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/TOPP_example_handling.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>File Handling</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">File Handling </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><h1><a class="anchor" id="TOPP_files_info"></a>
 
24
General information about peak and feature maps</h1>
 
25
<p>If you want some general information about a peak or feature map, use the <b>FileInfo</b> tool.</p>
 
26
<ul>
 
27
<li>It can print RT, m/z and intensity ranges, the overall number of peaks, and the distribution of MS levels</li>
 
28
<li>It can print a statistical summary of intensities</li>
 
29
<li>It can print some meta information</li>
 
30
<li>It can validate XML files against their schema</li>
 
31
<li>It can check for corrupt data in peak files See the 'FileInfo &ndash;help' for details.</li>
 
32
</ul>
 
33
<h1><a class="anchor" id="TOPP_files_info2"></a>
 
34
Problems with input files</h1>
 
35
<p>If you are experiencing problems while processing an XML file you can check if the file does validate against the XML schema: </p>
 
36
<div class="fragment"><div class="line">FileInfo -v -in <a class="code" href="namespaceOpenMS_1_1Internal_1_1ClassTest.html#a835c194d7465ac0e608fc154c9e9ef80">infile</a>.mzML</div>
 
37
</div><!-- fragment --><p> Validation is available for several file formats including mzML, mzData, mzXML, featureXML and idXML.</p>
 
38
<p>Another frequently-occuring problem is currupt data. You can check for corrupt data in peak files with <b>FileInfo</b> as well: </p>
 
39
<div class="fragment"><div class="line">FileInfo -c -in <a class="code" href="namespaceOpenMS_1_1Internal_1_1ClassTest.html#a835c194d7465ac0e608fc154c9e9ef80">infile</a>.mzML</div>
 
40
</div><!-- fragment --><h1><a class="anchor" id="TOPP_files_conversion"></a>
 
41
Converting your files to mzML</h1>
 
42
<p>The TOPP tools work only on the HUPO-PSI <em>mzML</em> format. If you need to convert <em>mzData</em>, <em>mzXML</em> or <em>ANDI/MS</em> data to <em>mzML</em>, you can do that using the <b>FileConverter</b>, e.g. </p>
 
43
<div class="fragment"><div class="line">FileConverter -in <a class="code" href="namespaceOpenMS_1_1Internal_1_1ClassTest.html#a835c194d7465ac0e608fc154c9e9ef80">infile</a>.mzXML -out outfile.mzML</div>
 
44
</div><!-- fragment --><p> If you use the format names as file extension, the tool derives the format from the extension. For other extensions, the file formats of the input and output file can be given explicitly.</p>
 
45
<h1><a class="anchor" id="TOPP_files_dta"></a>
 
46
Converting between DTA and mzML</h1>
 
47
<p>Sequest DTA files can be extracted from a mzML file using the <b>DTAExtractor:</b> </p>
 
48
<div class="fragment"><div class="line">DTAExtractor -in <a class="code" href="namespaceOpenMS_1_1Internal_1_1ClassTest.html#a835c194d7465ac0e608fc154c9e9ef80">infile</a>.mzML -out outfile</div>
 
49
</div><!-- fragment --><p> The retention time of a scan, the precursor mass-to-charge ratio (for MS/MS scans) and the file extension are appended to the output file name.</p>
 
50
<p>To combine several files (e.g. DTA files) to an mzML file use the <b>FileMerger:</b> </p>
 
51
<div class="fragment"><div class="line">FileMerger -in infile_list.txt -out outfile.mzML</div>
 
52
</div><!-- fragment --><p> The retention times of the scans can be generated, taken from the <em>infile_list.txt</em> or can be extrated from the DTA file names. See the FileMerger documentation for details.</p>
 
53
<h1><a class="anchor" id="TOPP_files_filter"></a>
 
54
Extracting part of the data from a file</h1>
 
55
<p>If you want to extract part of the data from an mzML file, you can use the <b>FileFilter</b> tool. It allows filtering for RT, m/z and intensity range or for MS level. To extract the MS/MS scans between retention time 100 and 1500, you would use the following command: </p>
 
56
<div class="fragment"><div class="line">FileFilter -in <a class="code" href="namespaceOpenMS_1_1Internal_1_1ClassTest.html#a835c194d7465ac0e608fc154c9e9ef80">infile</a>.mzML -levels 2 -rt 100:1500 -out outfile.mzML</div>
 
57
</div><!-- fragment --> </div></div><!-- contents -->
 
58
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
59
<TABLE width="100%" border="0">
 
60
<TR>
 
61
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
62
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:25 using doxygen 1.8.5</font></TD>
 
63
</TR>
 
64
</TABLE>
 
65
</BODY>
 
66
</HTML>