Evaluate a regular map-reduce call with progress updates
Usage
progressify(
expr,
substitute = TRUE,
...,
when = TRUE,
eval = TRUE,
envir = parent.frame()
)Expression unwrapping
The transpilation mechanism includes logic to "unwrap" expressions
enclosed in constructs such as !, { }, ( ), local(), I(),
identity(), invisible(), suppressMessages(), suppressWarnings(),
suppressPackageStartupMessages(), withCallingHandlers(), and
with(). The transpiler descends through wrapping
constructs until it finds a transpilable expression, avoiding the
need to place progressify() inside such constructs. This allows for
patterns like:
y <- {
lapply(xs, fcn)
} |> suppressMessages() |> progressify()avoiding having to write:
y <- {
lapply(xs, fcn) |> progressify()
} |> suppressMessages()Examples
handlers(global = TRUE) # listen to progress updates
#> Error: progressr::handlers(global = TRUE) cannot be called when condition handlers are active, which is a limitation of R's globalCallingHandlers(). Detected active handlers from: tryCatch(), withCallingHandlers(). This happens when it is called via tryCatch(), try(), withCallingHandlers(), suppressMessages(), suppressWarnings(), etc., from within a 'knitr', 'rmarkdown', or 'quarto' document, from a 'testthat' test, or from a package's .onLoad() or .onAttach() function. Instead, call it at the top level, e.g. at the R prompt, at the top of your R script, or in your ~/.Rprofile startup file. Alternatively, use with_progress() to report on progress for a specific expression.
xs <- list(1, 1:2, 1:2, 1:5)
y <- lapply(X = xs, FUN = sum) |> progressify()
str(y)
#> List of 4
#> $ : num 1
#> $ : int 3
#> $ : int 3
#> $ : int 15