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().
Examples
library(dplyr)
logFile <- tempfile(pattern = "log_{date}_{time}", fileext = ".txt")
createLogFile(logFile = logFile)
#> ! Overwriting current log file
#> ℹ Creating log file: /tmp/Rtmpv3DM9d/log_2025_05_06_23_24_161b9f10f9128f.txt.
#> [2025-05-06 23:24:16] - Log file created
logMessage("Starting analysis")
#> [2025-05-06 23:24:16] - Starting analysis
1 + 1
#> [1] 2
logMessage("Analysis finished")
#> [2025-05-06 23:24:16] - Analysis finished
res <- summariseLogFile()
#> [2025-05-06 23:24:16] - Exporting log file
glimpse(res)
#> Rows: 4
#> Columns: 13
#> $ result_id <int> 1, 1, 1, 1
#> $ cdm_name <chr> "unknown", "unknown", "unknown", "unknown"
#> $ group_name <chr> "overall", "overall", "overall", "overall"
#> $ group_level <chr> "overall", "overall", "overall", "overall"
#> $ strata_name <chr> "log_id", "log_id", "log_id", "log_id"
#> $ strata_level <chr> "1", "2", "3", "4"
#> $ variable_name <chr> "Log file created", "Starting analysis", "Analysis fi…
#> $ variable_level <chr> NA, NA, NA, NA
#> $ estimate_name <chr> "date_time", "date_time", "date_time", "date_time"
#> $ estimate_type <chr> "character", "character", "character", "character"
#> $ estimate_value <chr> "2025-05-06 23:24:16", "2025-05-06 23:24:16", "2025-0…
#> $ additional_name <chr> "overall", "overall", "overall", "overall"
#> $ additional_level <chr> "overall", "overall", "overall", "overall"
tidy(res)
#> # A tibble: 4 × 5
#> cdm_name log_id variable_name variable_level date_time
#> <chr> <chr> <chr> <chr> <chr>
#> 1 unknown 1 Log file created NA 2025-05-06 23:24:16
#> 2 unknown 2 Starting analysis NA 2025-05-06 23:24:16
#> 3 unknown 3 Analysis finished NA 2025-05-06 23:24:16
#> 4 unknown 4 Exporting log file NA 2025-05-06 23:24:16