Skip to content

Update file-handling.md #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/getting-started/types-of-topp-tools/file-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,27 @@ The TOPP tools work only on the HUPO-PSI `mzML` format. If you need to convert *
For 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.

## Compression of mzML files


OpenMS has supported **reading** of compressed mzML, mzXML, and mzData for a long time.

Since OpenMS 3.5, TOPP tools that produce mzML output files also support **writing** compressed gzipped `.mzML.gz` files.
To enable compression, simply use `mzML.gz` instead of `.mzML` as the output filename.

For example, PeakPickerHiRes can output compressed files like this:

`PeakPickerHiRes -in input.mzML -out output.mzML.gz -threads 8`

Compression uses the `pigz` (parallel gzip) tool, if installed, or falls back to OpenMS's internal compression mechanism otherwise. `pigz` offers faster compression speed, even if only using one thread. The number of threads used for compression is determined by the usual `-threads <n>` flag of the TOPP tool.
Without pigz, the internal gzip compressor is used, which only supports a single thread, irrespective of the value given in `-threads <n>`.


compression efficiency: `.mzML.gz` files are typically 2-3x smaller
compression speed: `pigz` is significantly faster than the internal compression. Install `pigz` if possible (it's available via the usual package managers),



## Converting between DTA and mzML

Sequest DTA files can be extracted from a mzML file using the `DTAExtractor`:
Expand Down Expand Up @@ -119,4 +140,4 @@ It can currently write the following formats:

This example shows how to convert pepXML to idXML:

`IDFileConverter -in infile.pepXML -out outfile.idXML`
`IDFileConverter -in infile.pepXML -out outfile.idXML`
Loading