OpenMS
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
OpenMSDatabasesInfo

Information about OpenMS' internal databases

This util prints the content of OpenMS' enzyme and modification databases to a TSV file. The command line parameters of this tool are:

OpenMSDatabasesInfo -- Prints the content of OpenMS' enzyme and modification databases to TSV
Full documentation: http://www.openms.de/doxygen/nightly/html/TOPP_OpenMSDatabasesInfo.html
Version: 3.4.0-pre-nightly-2025-03-10 Mar 11 2025, 02:37:22, Revision: 1d7b3f7
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:
  OpenMSDatabasesInfo <options>

Options (mandatory options marked with '*'):
  -enzymes_out <out>*  Currently supported enzymes as TSV (valid formats: 'tsv')
  -mods_out <out>*     Currently supported modifications as TSV (valid formats: 'tsv')
                       
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:

Legend:
required parameter
advanced parameter
+OpenMSDatabasesInfoPrints the content of OpenMS' enzyme and modification databases to TSV
version3.4.0-pre-nightly-2025-03-10 Version of the tool that generated this parameters file.
++1Instance '1' section for 'OpenMSDatabasesInfo'
enzymes_out Currently supported enzymes as TSVoutput file*.tsv
mods_out Currently supported modifications as TSVoutput file*.tsv
log Name of log file (created only when specified)
debug0 Sets the debug level
threads1 Sets the number of threads allowed to be used by the TOPP tool
no_progressfalse Disables progress logging to command linetrue, false
forcefalse Overrides tool-specific checkstrue, false
testfalse Enables the test mode (needed for internal use only)true, false