R/log.R

In paul4forest/tradeflows: Process forest products trade flow data from COMTRADE and COMEXT

#' Write errors to a log file
#' @param condition warning or error condition as returned by \link{tryCatch}
#' @param logfile character path to a log file
#' @param optionaltext character additional text added after the timestamp
#' @examples
#' # Create a log file name
#' logfileexample <- file.path(tempdir(),"log.txt")
#' # Catch an error
#'  tryCatch({
#'      stop("There is an error in this exampe.")
#'  }, error = function(errorcondition){
#'             writeerror2log(errorcondition, logfileexample, "code: 123456")
#'  })
#'  # Read the log file
#' readLines(logfileexample)
#' @export
writeerror2log <- function(condition, logfile, optionaltext = NULL){
    folder <- dirname(logfile)
    if(!file.exists(folder)){
        message("The folder ", folder, " doesn't exist, creating it.")
        dir.create(folder, recursive = TRUE)
    }
    write(paste(as.character(Sys.time()), optionaltext, "\n",
                toString(condition)),
          logfile, append=TRUE)
}

#' Add a dot at the end of a text file
#' while keeping a new line character at the end of the file
#' so that it is valid for \code{readLines}.
#' @param logfile character path to a log file
#' @export
adddot2logfile <- function(logfile){
    if(file.exists(logfile)){
        logfilecontent <- readLines(logfile)
    } else {
        logfilecontent <- ""
    }
    # Add a dot to the last line
    logfilecontent[length(logfilecontent)] <- paste0(
        logfilecontent[length(logfilecontent)],
        ".")
    # Write back to the file
    writeLines(logfilecontent, logfile)
}