writeLog: (internal) Error Logging

Description Usage Arguments Methods (by class)

Description

The method writes and displaye logging message to the log files.

Usage

1
2
3
4
5
writeLog(object, type, level, message, show, ...)

## S4 method for signature 'Commons,character'
writeLog(object, type, level = "info", message,
  show = FALSE, ..., maxSizeInMb = 1, keptDay = 90)

Arguments

object

Commons class object.

type

a character string. The logging type of either 'setup' for project_setup.log or 'process' for data_process.log.

level

a character string. The logging level of either 'error', 'warn', 'info', or 'debug'. The default value is 'info'.

message

a character string. The logging message.

show

a logical value. If TRUE, console display the log messaage; If FALSE (default), not display.

...

There are optional arguments.

maxSizeInMb

a integer. (optional) The maximum size (MB) of a log file. The log file is moved to archieved_log directory after reaching the maximum size (default 1MB).

keptDay

an integer. (optional) The maximum days of an archieved log file is kept. The archived log file is deleted after the duration Day is past (default 90 days).

Methods (by class)


jameslhao/dbgapr_dev documentation built on May 8, 2019, 11:03 p.m.