handler_ascii_alert: Progression Handler: Progress Reported as ASCII BEL Symbols...

View source: R/handler_ascii_alert.R

handler_ascii_alertR Documentation

Progression Handler: Progress Reported as ASCII BEL Symbols (Audio or Blink) in the Terminal

Description

A progression handler based on cat("\a", file=stderr()).

Usage

handler_ascii_alert(
  symbol = "\a",
  file = stderr(),
  intrusiveness = getOption("progressr.intrusiveness.audio", 5),
  target = c("terminal", "audio"),
  ...
)

Arguments

symbol

(character string) The character symbol to be outputted, which by default is the ASCII BEL character ('\a' = '\007') character.

file

(connection) A base::connection to where output should be sent.

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().

Examples

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

progressr documentation built on Aug. 11, 2023, 1:07 a.m.