library(ptspotter) #> Loading required package: beepr #> Loading required package: log4r #> #> Attaching package: 'log4r' #> The following object is masked from 'package:base': #> #> debug #> Loading required package: this.path #> Registered S3 method overwritten by 'pryr': #> method from #> print.bytes Rcpp
Logging is an excellent way to monitor the status of your data pipelines. Please consult the ‘log4r’ documentation for a comprehensive guide to its features.
In order to quickly get up and running with ‘log4r’, there are a few steps to take first. A directory and a logfile are required.
This will only need to be executed once. Running this line again will throw an error.
Next we need to create the required objects within R to be able to write to the logfile we created. Namely, a file appender and logger objects are needed. This needs to be executed every time you run your programme, so include it within your script.
We can now use the logging functions in ‘log4r’ to begin writing messages to the logfile.
log4r::info(logger = my_logger, message = "Some info") log4r::warn(logger = my_logger, message = "Some warning") log4r::error(logger = my_logger, message = "Some error") # Check the messages are being logged readLines("logs/logfile.txt") #>  "INFO [2023-08-13 14:42:42] Some info" #>  "WARN [2023-08-13 14:42:42] Some warning" #>  "ERROR [2023-08-13 14:42:42] Some error"