![]() |
OpenMS
|
Shows basic information about the data in an OpenMS readable file.
| pot. predecessor tools | → FileInfo → | pot. successor tools |
|---|---|---|
| any tool operating on MS peak data (in mzML format) | none ; console or text file |
This tool can show basic information about the data in different file types, such as raw peak, featureXML and consensusXML files. It can
The command line parameters of this tool are:
FileInfo -- Shows basic information about the file, such as data ranges and file type.
Full documentation: http://www.openms.de/doxygen/nightly/html/TOPP_FileInfo.html
Version: 3.6.0-pre-nightly-2026-03-12 Mar 13 2026, 01:45:58, Revision: 88f2819
To cite OpenMS:
+ Pfeuffer, J., Bielow, C., Wein, S. et al.. OpenMS 3 enables reproducible analysis of large-scale mass spec
trometry data. Nat Methods (2024). doi:10.1038/s41592-024-02197-7.
Usage:
FileInfo <options>
Options (mandatory options marked with '*'):
-in <file>* Input file (valid formats: 'mzData', 'mzXML', 'mzML', 'sqMass', 'dta', 'dta2d', 'mgf',
'featureXML', 'consensusXML', 'idXML', 'pepXML', 'mzTab', 'fid', 'mzid', 'trafoXML',
'fasta', 'pqp')
-in_type <type> Input file type -- default: determined from file extension or content (valid: 'mzData',
'mzXML', 'mzML', 'sqMass', 'dta', 'dta2d', 'mgf', 'featureXML', 'consensusXML', 'idXML',
'pepXML', 'mzTab', 'fid', 'mzid', 'trafoXML', 'fasta', 'pqp')
-out <file> Optional output file. If left out, the output is written to the command line. (valid
formats: 'txt')
-m Show meta information about the whole experiment
-p Shows data processing information
-s Computes a five-number statistics of intensities, qualities, and widths
-d Show detailed listing of all spectra and chromatograms (peak files only)
-c Check for corrupt data in the file (peak files only)
-v Validate the file only (for mzML, mzData, mzXML, featureXML, idXML, consensusXML, pepXML
)
-i Check whether a given mzML file contains valid indices (conforming to the indexedmzML
standard)
Common TOPP options:
-ini <file> Use the given TOPP INI file
-threads <n> Sets the number of threads allowed to be used by the TOPP tool (default: '1')
-write_ini <file> Writes the default configuration file
--help Shows options
--helphelp Shows all options (including advanced)
INI file documentation of this tool:
This section lists all parameters supported by the tool. Parameters are organized into hierarchical subsections that group related settings together. Subsections may contain further subsections or individual parameters.
Each parameter entry contains the following information:
Parameter tags provide additional information about how a parameter is used. Some tags indicate whether a parameter is required or intended for advanced configuration, while others may be used internally by OpenMS or workflow tools.
Parameters highlighted as required must be specified for the tool to run successfully. Parameters marked as advanced allow fine-tuning of algorithm behavior and are typically not needed for standard workflows.
In order to enrich the resulting data of your analysis pipeline or to quickly compare different outcomes of your pipeline you can invoke the aforementioned information of your input data and (intermediary) results.