Description of MicrobeMS' main parameter file 'microbems.opt': Difference between revisions

From MicrobeMS Wiki
Jump to navigation Jump to search
Line 27: Line 27:
<tt>
<tt>
  ###
  ###
  800                                             ## data.pre.autoppm
  800                                                 ## data.pre.autoppm
  1 -4 5 8 60                                     ## data.pre.basln
  1 -4 5 8 60                                         ## data.pre.basln
  21                                               ## data.pre.smo
  21                                                   ## data.pre.smo
  5                                               ## data.pre.redres
  5                                                   ## data.pre.redres
  2000 13000                                       ## data.pre.cut
  2000 13000                                           ## data.pre.cut
  microbems.opt                                   ## data.DefFile
  microbems.opt                                       ## data.DefFile
  #- SMO#- BAS#- NRM                               ## data.mkdb.seq
  #- SMO#- BAS#- NRM                                   ## data.mkdb.seq
  21                                               ## data.mkdb.nsp
  21                                                   ## data.mkdb.nsp
  1 -4 5 8 60                                     ## data.mkdb.bas
  1 -4 5 8 60                                         ## data.mkdb.bas
  1                                               ## data.mkdb.nrm
  1                                                   ## data.mkdb.nrm
  2000 15000                                       ## data.mkdb.cut
  2000 15000                                           ## data.mkdb.cut
  1                                               ## data.mkdb.red
  1                                                   ## data.mkdb.red
                                                  ## data.mkdb.clb
                                                      ## data.mkdb.clb
  2000 13000 300 12000 7000 0.075 7.5 800 1 40     ## data.mkdb.ppr
  2000 13000 300 12000 7000 0.075 7.5 800 1 40         ## data.mkdb.ppr
  1                                               ## data.mkdb.int
  1                                                   ## data.mkdb.int
  0.25                                             ## data.mkdb.threshold
  0.25                                                 ## data.mkdb.threshold
  0.75                                             ## data.mkdb.fmaxnpks
  0.75                                                 ## data.mkdb.fmaxnpks
  1                                               ## data.allwdispdbavspc
  1                                                   ## data.allwdispdbavspc
  1                                               ## data.usebasintpiktbl
  1                                                   ## data.usebasintpiktbl
  #- SMO#- BAS#- NRM                               ## data.ident.seq
  #- SMO#- BAS#- NRM                                   ## data.ident.seq
  21                                               ## data.ident.nsp
  21                                                   ## data.ident.nsp
  1 -4 8 8 60                                     ## data.ident.bas
  1 -4 8 8 60                                         ## data.ident.bas
  1                                               ## data.ident.nrm
  1                                                   ## data.ident.nrm
  2000 15000                                       ## data.ident.cut
  2000 15000                                           ## data.ident.cut
  1                                               ## data.ident.red
  1                                                   ## data.ident.red
                                                  ## data.ident.clb
                                                      ## data.ident.clb
  20                                               ## data.ident.hit
  20                                                   ## data.ident.hit
  2000 13000 300 12000 7000 0.075 7.5 800 1 30     ## data.ident.ppr
  2000 13000 300 12000 7000 0.075 7.5 800 1 30         ## data.ident.ppr
  2.5 2.75                                         ## data.ident.scores
  2.5 2.75                                             ## data.ident.scores
  400 600                                         ## data.ident.soi
  400 600                                             ## data.ident.soi
  '2023-Feb-06-full-db-800ppm-40-peaks-0.pkf'     ## data.ident.pkf
  '2023-Feb-06-full-db-800ppm-40-peaks-0.pkf'         ## data.ident.pkf
  'E:\MALDI MO\MALDI DB\Peaklists (pkf)'           ## data.ident.pth
  'E:\MALDI MO\MALDI DB\Peaklists (pkf)'               ## data.ident.pth
  200                                             ## data.defx.start
  200                                                 ## data.defx.start
  30 45                                           ## data.qual.qtresvalthresh
  30 45                                               ## data.qual.qtresvalthresh
  10                                               ## data.qual.nbins
  10                                                   ## data.qual.nbins
  20 800                                           ## data.qual.noiselvl
  20 800                                               ## data.qual.noiselvl
  0.2500                                           ## data.qual.noisewf
  0.2500                                               ## data.qual.noisewf
  150 1500                                         ## data.qual.baslnrrorlvl
  150 1500                                             ## data.qual.baslnrrorlvl
  0.2000                                           ## data.qual.baslerrwf
  0.2000                                               ## data.qual.baslerrwf
  200 800                                         ## data.qual.respowerlvl
  200 800                                             ## data.qual.respowerlvl
  0.2500                                           ## data.qual.respowerwf
  0.2500                                               ## data.qual.respowerwf
  5 80                                             ## data.qual.npeakslvl
  5 80                                                 ## data.qual.npeakslvl
  0.3000                                           ## data.qual.npeakswf
  0.3000                                               ## data.qual.npeakswf
  2000 13000 7000 0.075 7.5 800 1 30               ## data.maldi.ppr
  2000 13000 7000 0.075 7.5 800 1 30                   ## data.maldi.ppr
  2000 700 2000 0.10 5 800 1 99999999             ## data.lcms1.ppr
  2000 700 2000 0.10 5 800 1 99999999                 ## data.lcms1.ppr


</tt>|-
</tt>
|-
|}
|}
</ul></ul>
</ul></ul>

Revision as of 18:20, 30 October 2024

Introduction

Important notice: With MicrobeMS v. 0.82 the format of the parameter file microbems.opt has changed!

The file microbems.opt is a simple text file which is read upon initialization by MicrobeMS. The file microbems.opt contains a number of program-wide parameters and parameters required for auto-preprocessing and auto-peak detection from raw (original) mass spectra. Auto-preprocessing and auto-peak detection is carried when generating database spectra and in the workflow for microbial identification based on mass spectral libraries and interspectral distances.
The file microbems.opt can be usually found in one of the following directories:

      • MicrobeMS installed as a Matlab toolbox (pcode), Windows operating system (XP/Vista/W7/W8/W8.1/W10): root directory of the MicrobeMS toolbox, usually 'C:\program files\Matlab\R2014a\toolbox\matlab\mass' with C:\program files\Matlab\R2014a equaling the variable 'matlabroot'. Note that the string 'R2014a' denotes the Matlab version which is actually used.
      • Alternatively, the file microbems.opt can be also stored in the directory C:\users\WindowsUserName\Documents\Matlab with WindowsUserName being the user's Windows name (compiled Windows versions of MicrobeMS).
      • LINUX version (Debian): the file microbems.opt must reside in the pcode toolbox directory of MicrobeMS. Type ' >> which mass ' at the Matlab prompt when searching for this directory.

Content of microbems.opt

The file 'microbems.opt' is s simple text file which can be edited by text editors like Notepad, Textpad or Notepad++. The following table shows an example of the contents of 'microbems.opt':

      Content of the file microbems.opt:

      ###
      800                                                  ## data.pre.autoppm
      1 -4 5 8 60                                          ## data.pre.basln
      21                                                   ## data.pre.smo
      5                                                    ## data.pre.redres
      2000 13000                                           ## data.pre.cut
      microbems.opt                                        ## data.DefFile
      #- SMO#- BAS#- NRM                                   ## data.mkdb.seq
      21                                                   ## data.mkdb.nsp
      1 -4 5 8 60                                          ## data.mkdb.bas
      1                                                    ## data.mkdb.nrm
      2000 15000                                           ## data.mkdb.cut
      1                                                    ## data.mkdb.red
                                                           ## data.mkdb.clb
      2000 13000 300 12000 7000 0.075 7.5 800 1 40         ## data.mkdb.ppr
      1                                                    ## data.mkdb.int
      0.25                                                 ## data.mkdb.threshold
      0.75                                                 ## data.mkdb.fmaxnpks
      1                                                    ## data.allwdispdbavspc
      1                                                    ## data.usebasintpiktbl
      #- SMO#- BAS#- NRM                                   ## data.ident.seq
      21                                                   ## data.ident.nsp
      1 -4 8 8 60                                          ## data.ident.bas
      1                                                    ## data.ident.nrm
      2000 15000                                           ## data.ident.cut
      1                                                    ## data.ident.red
                                                           ## data.ident.clb
      20                                                   ## data.ident.hit
      2000 13000 300 12000 7000 0.075 7.5 800 1 30         ## data.ident.ppr
      2.5 2.75                                             ## data.ident.scores
      400 600                                              ## data.ident.soi
      '2023-Feb-06-full-db-800ppm-40-peaks-0.pkf'          ## data.ident.pkf
      'E:\MALDI MO\MALDI DB\Peaklists (pkf)'               ## data.ident.pth
      200                                                  ## data.defx.start
      30 45                                                ## data.qual.qtresvalthresh
      10                                                   ## data.qual.nbins
      20 800                                               ## data.qual.noiselvl
      0.2500                                               ## data.qual.noisewf
      150 1500                                             ## data.qual.baslnrrorlvl
      0.2000                                               ## data.qual.baslerrwf
      200 800                                              ## data.qual.respowerlvl
      0.2500                                               ## data.qual.respowerwf
      5 80                                                 ## data.qual.npeakslvl
      0.3000                                               ## data.qual.npeakswf
      2000 13000 7000 0.075 7.5 800 1 30                   ## data.maldi.ppr
      2000 700 2000 0.10 5 800 1 99999999                  ## data.lcms1.ppr
      

It is required to restart MicrobeMS to initialize changes made to the microbems.opt file.

Parameters stored in microbems.opt

General parameters

  • data.DefFile - name of the parameter file. Usually 'microbems.opt', Please do not modify!
  • data.defx.start - start value (in m/z units) of the m/z vector used by the function defx (modification not recommended)
  • data.allwdispdbavspc - if set to 1: database or average spectra are displayed in the spectra panel, otherwise 0
  • data.usebasintpiktbl - if set to 1: use baseline-corrected intensities for the generation of peak tables , otherwise 0

Parameters used for auto-preprocessing and auto-peak detection when creating database spectra

  • data.mkdb.seq - defines the sequence of pre-processing steps, see spectral pre-processing
  • data.mkdb.nsp - the number of smoothing points (Savitzky-Golay smoothing), see spectral pre-processing, smoothing
  • data.mkdb.niv - defines the number of segments (intervals) used spectra for baseline correction, see spectral pre-processing, baseline correction
  • data.mkdb.nrm - if set to 1 spectra are normalized otherwise 0, see spectral pre-processing, normalization
  • data.mkdb.cut - useful to narrow the m/z range of mass spectra, see spectral pre-processing, cut
  • data.mkdb.red - factor to reduce the effective spectral resolution of mass spectra, see spectral pre-processing, reduce resolution
  • data.mkdb.clb - autocalibration parameters (not used before MicrobeMS version 0.82), see spectral pre-processing, auto-calibration
  • data.mkdb.ppr - peak detection parameters, see peak detection for details
  • data.mkdb.int - if set to 1: create db spectra with intensities (non-barcode spectra), otherwise 0
  • data.mkdb.threshold - defines the minimum required frequency a peak must be present in the individual peak tables
  • data.mkdb.fmaxnpks - a factor defining how much the number of peaks in the database spectrum may exceed the number of peaks present in individual mass spectra

Parameters used for auto-preprocessing and auto-peak detection in the microbial identification workflow

Downloading microbems.opt

The text file microbems.opt can be downloaded here (MicrobeMS v. 0.82 and later): http://wiki.microbe-ms.com/uploads/microbems.opt