logMessage: Log a message to a logFile

View source: R/logger.R

logMessageR Documentation

Log a message to a logFile

Description

The message is written to the logFile and displayed in the console, if logFile does not exist the message is only displayed in the console.

Usage

logMessage(
  message = "Start logging file",
  logFile = getOption("omopgenerics.logFile")
)

Arguments

message

Message to log.

logFile

File path to write logging messages. Create a logFile with createLogFile().

Value

Invisible TRUE if the logging message is written to a log file.

Examples

library(dplyr)

logFile <- tempfile(pattern = "log_{date}_{time}", fileext = ".txt")
createLogFile(logFile = logFile)

logMessage("Starting analysis")
1 + 1
logMessage("Analysis finished")

res <- summariseLogFile()

glimpse(res)

tidy(res)


omopgenerics documentation built on June 8, 2025, 10:40 a.m.