handler_tkprogressbar: Progression Handler: Progress Reported as a Tcl/Tk Progress...

Description Usage Arguments Requirements Examples

View source: R/handler_tkprogressbar.R

Description

A progression handler for tcltk::tkProgressBar().

Usage

1
2
3
4
5
handler_tkprogressbar(
  intrusiveness = getOption("progressr.intrusiveness.gui", 1),
  target = "terminal",
  ...
)

Arguments

intrusiveness

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

target

(character vector) Specifies where progression updates are rendered.

...

Additional arguments passed to make_progression_handler().

Requirements

This progression handler requires the tcltk package and that the current R session supports Tcl/Tk (capabilities("tcltk")).

Examples

1
2
3
4
5
6
7
if (capabilities("tcltk") && requireNamespace("tcltk", quietly = TRUE)) {

  handlers("tkprogressbar")
  with_progress({ y <- slow_sum(1:10) })
  print(y)
  
}

progressr documentation built on Sept. 24, 2021, 5:07 p.m.