emailNotifier: email notification system for LC-MS analyses

In WMBEdmands/simExTargId: Simultaneous peak-picking and MS2 target identification using XCMS.

Description

email notification system for LC-MS analyses

Usage

emailNotifier(rawDir = NULL, emailAddress = NULL, emailTime = 10,
  maxTime = 60, mailControl = list(smtpServer = "ASPMX.L.GOOGLE.COM"),
  minFiles = 5, nMad = 3)

Arguments

rawDir	character full path name of raw data directory into which raw data will eventually/ has already been started to be written.
emailAddress	character vector email address(es) from and to which to send warning email that run may have stopped. (if not supplied then email notification will not be sent) see sendmail. The first email address in the character vector will be the email address which warning emails are sent from to all of the other email addresses supplied. N.B. Currently the email addresses must use the same SMTP server setting (e.g. all google mail, see mailControl argument below).
emailTime	numeric length of time (in minutes) after the last raw data file was written before an email notification will be sent. minimum value is 5 minutes.
maxTime	numeric the maximum time before the email notifier process will stop altogether so it does not continue ad infinitum and the eventual return of the cosmos to a state of maximum entropy (default = 60 mins).
mailControl	List of SMTP server settings see sendmail for details. Example given is for google mail.
minFiles	integer the minimum number of files that must be collected before the median absolute deviation is calculated (default = 5).
nMad	numeric the number of median absolute deviations smaller a file must be for an email warning to be sent (default = 3). Reducing this value may make it more sensitive to subtle reductions in file size but increase the risk of false positive warning email messages. Utilizes the base function mad in the stats package.

WMBEdmands/simExTargId documentation built on May 24, 2019, 2:08 a.m.