progressr (version 0.16.0)

handler_slowdown: Progression Handler: Slow Down Progress Reporting

Description

Progression Handler: Slow Down Progress Reporting

Usage

handler_slowdown(
  duration = 10,
  intrusiveness = 0,
  target = "void",
  enable = getOption("progressr.enable", TRUE),
  ...
)

Arguments

duration

(numeric) Added slowdown (in seconds) across all progress steps, e.g. if duration = 10.0 and steps = 100L, then each step unit is delayed 0.1 seconds, totaling a ten-second slowdown.

intrusiveness

(numeric) A non-negative scalar on how intrusive (disruptive) the reporter to the user.

target

(character vector) Specifies where progression updates are rendered.

enable

(logical) If FALSE, then progress is not reported.

...

Additional arguments passed to make_progression_handler().

Details

This progression handler delays each progress step a certain number of seconds. It does not render any output.

Examples

if (FALSE) {
handlers(handler_slowdown(duration = 30.0)) ## 30-second total slowdown
with_progress(y <- slow_sum(1:100))
print(y)
}