handler_beepr: Progression Handler: Progress Reported as 'beepr' Sounds...

In progressr: An Inclusive, Unifying API for Progress Updates

Progression Handler: Progress Reported as 'beepr' Sounds (Audio)

Description

A progression handler for beepr::beep().

Usage

handler_beepr(
  initiate = 2L,
  update = 10L,
  finish = 11L,
  interrupt = 9L,
  intrusiveness = getOption("progressr.intrusiveness.audio", 5),
  target = "audio",
  ...
)

Arguments

initiate, update, finish, interrupt	(integer) Indices of beepr::beep() sounds to play when progress starts, is updated, completes, or is interrupted. For silence, use NA_integer_.
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 beepr package.

Examples

if (requireNamespace("beepr", quietly = TRUE)) {

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

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