R/log_message.R

In delta1epsilon/logtime: Logging and timing of your code

# Create log function
#
# @param level A default logging level for log function
# @param logger_name A string
# @param file A string
create_log_function <- function (level = 'DEBUG', logger_name = NULL, file = '') {
    logger_level = level

    function (message, level = logger_level) {
        check_if_level_valid(level)

        time <- format(Sys.time(), format = '%Y-%m-%d %H:%M:%S')

        log <- get_log(message, time = time, level = level, logger_name = logger_name, file = file)
        print_log(log, logger_name = logger_name, file = file)
    }
}

#' Print Log message
#'
#' @param message A string
#' @param level A logging level. One of 'DEBUG', 'INFO', 'WARNING', 'ERROR'. Default is 'DEBUG'.
#' @return Prints log to console or file. This can be controlled with \code{configure_logging} or \code{create_logger} if \code{log_message} is used inside logger context.
#'
#' @seealso \code{\link{log_time}}
#'
#' @examples
#'
#' # create a log with message 'Some text'
#' log_message('Some text')  # default level is DEBUG
#' # output:
#' # 2016-09-21 10:55:18 - DEBUG - [Some text]
#'
#'
#' # create the same log with changed level to INFO
#' log_message('Some text', level = 'INFO')
#' # output:
#' # 2016-09-21 10:55:38 - INFO - [Some text]
#'
#' @export
log_message <- create_log_function()