Skip to contents

Configure Progress Handlers

Source: R/progress_utils.R
configure_progress.Rd

Convenience function to configure progressr handlers for the current session.

Usage

configure_progress(handler = "txtprogressbar", ...)

Arguments

handler

Character string specifying the handler type:

  • "progress": progress package style (if available)

  • "txtprogressbar": base R text progress bar

  • "cli": cli package style (if available)

  • "none": Disable progress reporting

  • NULL: Use progressr default handlers

...

Additional arguments passed to progressr::handlers()

Value

Invisibly returns the configured handlers (via progressr::handlers()).

Details

This is a convenience wrapper around progressr::handlers(). If progressr is not available, a warning is issued and the function returns NULL.

See also

progressr::handlers()

Examples

if (FALSE) { # \dontrun{
# Use base R text progress bar
configure_progress("txtprogressbar")

# Use cli style (if cli package is installed)
configure_progress("cli")

# Disable progress reporting
configure_progress("none")
} # }