Evaluate an expression and log results

Usage

log_eval(expr, level = TRACE, multiline = FALSE)

Arguments

expr: R expression to be evaluated while logging the expression itself along with the result
level: log_levels()
multiline: setting to FALSE will print both the expression (enforced to be on one line by removing line-breaks if any) and its result on a single line separated by =>, while setting to TRUE will log the expression and the result in separate sections reserving line-breaks and rendering the printed results

Examples

log_eval(pi * 2, level = INFO)
#> INFO [2024-10-21 07:31:19] 'pi * 2' => '6.28318530717959'
#> [1] 6.283185

## lowering the log level threshold so that we don't have to set a higher level in log_eval
log_threshold(TRACE)
log_eval(x <- 4)
#> TRACE [2024-10-21 07:31:19] 'x <- 4' => '4'
log_eval(sqrt(x))
#> TRACE [2024-10-21 07:31:19] 'sqrt(x)' => '2'
#> [1] 2

## log_eval can be called in-line as well as returning the return value of the expression
x <- log_eval(mean(runif(1e3)))
#> TRACE [2024-10-21 07:31:19] 'mean(runif(1000))' => '0.506193717753049'
x
#> [1] 0.5061937

## https://twitter.com/krlmlr/status/1067864829547999232
f <- sqrt
g <- mean
x <- 1:31
log_eval(f(g(x)), level = INFO)
#> INFO [2024-10-21 07:31:19] 'f(g(x))' => '4'
#> [1] 4
log_eval(y <- f(g(x)), level = INFO)
#> INFO [2024-10-21 07:31:19] 'y <- f(g(x))' => '4'

## returning a function
log_eval(f <- sqrt)
#> TRACE [2024-10-21 07:31:19] 'f <- sqrt' => '.Primitive("sqrt")'
log_eval(f)
#> TRACE [2024-10-21 07:31:19] 'f' => '.Primitive("sqrt")'
#> function (x)  .Primitive("sqrt")

## evaluating something returning a wall of "text"
log_eval(f <- log_eval)
#> TRACE [2024-10-21 07:31:19] 'f <- log_eval' => 'function (expr, level = TRACE, multiline = FALSE)  {     expr <- substitute(expr)     exprs <- gsub("\n", " ", deparse(expr), fixed = TRUE)     timer <- Sys.time()     res <- withVisible(eval.parent(expr))     if (multiline == FALSE) {         log_level(level, skip_formatter(paste(shQuote(paste(exprs,              collapse = " ")), "=>", shQuote(paste(gsub("\n",              " ", deparse(res$value)), collapse = " ")))))     }     else {         log_level(level, "Running expression: ====================")         log_level(level, skip_formatter(exprs))         log_level(level, "Results: ===============================")         log_level(level, skip_formatter(capture.output(res$value)))         log_level(level, paste("Elapsed time:", round(difftime(Sys.time(),              timer, units = "secs"), 2), "sec"))     }     if (res$visible == TRUE) {         return(res$value)     }     else {         return(invisible(res$value))     } }'
log_eval(f <- log_eval, multiline = TRUE)
#> TRACE [2024-10-21 07:31:19] Running expression: ====================
#> TRACE [2024-10-21 07:31:19] f <- log_eval
#> TRACE [2024-10-21 07:31:19] Results: ===============================
#> TRACE [2024-10-21 07:31:19] function (expr, level = TRACE, multiline = FALSE) 
#> TRACE [2024-10-21 07:31:19] {
#> TRACE [2024-10-21 07:31:19]     expr <- substitute(expr)
#> TRACE [2024-10-21 07:31:19]     exprs <- gsub("\n", " ", deparse(expr), fixed = TRUE)
#> TRACE [2024-10-21 07:31:19]     timer <- Sys.time()
#> TRACE [2024-10-21 07:31:19]     res <- withVisible(eval.parent(expr))
#> TRACE [2024-10-21 07:31:19]     if (multiline == FALSE) {
#> TRACE [2024-10-21 07:31:19]         log_level(level, skip_formatter(paste(shQuote(paste(exprs, 
#> TRACE [2024-10-21 07:31:19]             collapse = " ")), "=>", shQuote(paste(gsub("\n", 
#> TRACE [2024-10-21 07:31:19]             " ", deparse(res$value)), collapse = " ")))))
#> TRACE [2024-10-21 07:31:19]     }
#> TRACE [2024-10-21 07:31:19]     else {
#> TRACE [2024-10-21 07:31:19]         log_level(level, "Running expression: ====================")
#> TRACE [2024-10-21 07:31:19]         log_level(level, skip_formatter(exprs))
#> TRACE [2024-10-21 07:31:19]         log_level(level, "Results: ===============================")
#> TRACE [2024-10-21 07:31:19]         log_level(level, skip_formatter(capture.output(res$value)))
#> TRACE [2024-10-21 07:31:19]         log_level(level, paste("Elapsed time:", round(difftime(Sys.time(), 
#> TRACE [2024-10-21 07:31:19]             timer, units = "secs"), 2), "sec"))
#> TRACE [2024-10-21 07:31:19]     }
#> TRACE [2024-10-21 07:31:19]     if (res$visible == TRUE) {
#> TRACE [2024-10-21 07:31:19]         return(res$value)
#> TRACE [2024-10-21 07:31:19]     }
#> TRACE [2024-10-21 07:31:19]     else {
#> TRACE [2024-10-21 07:31:19]         return(invisible(res$value))
#> TRACE [2024-10-21 07:31:19]     }
#> TRACE [2024-10-21 07:31:19] }
#> TRACE [2024-10-21 07:31:19] <bytecode: 0x559672c685e8>
#> TRACE [2024-10-21 07:31:19] <environment: namespace:logger>
#> TRACE [2024-10-21 07:31:19] Elapsed time: 0 sec

## doing something computationally intensive
log_eval(system.time(for (i in 1:100) mad(runif(1000))), multiline = TRUE)
#> TRACE [2024-10-21 07:31:19] Running expression: ====================
#> TRACE [2024-10-21 07:31:19] system.time(for (i in 1:100) mad(runif(1000)))
#> TRACE [2024-10-21 07:31:19] Results: ===============================
#> TRACE [2024-10-21 07:31:19]    user  system elapsed 
#> TRACE [2024-10-21 07:31:19]   0.010   0.000   0.011 
#> TRACE [2024-10-21 07:31:19] Elapsed time: 0.1 sec
#>    user  system elapsed 
#>   0.010   0.000   0.011