handler_ntfy {progressr} | R Documentation |
Progression Handler: Progress Reported via the Ntfy.sh Messaging Service
Description
A progression handler for ntfy::ntfy_send()
of the ntfy package,
which sends notifications via the https://ntfy.sh framework.
Usage
handler_ntfy(
intrusiveness = getOption("progressr.intrusiveness.ntfy", 5),
target = "gui",
...,
title = "Progress update from R"
)
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. |
title |
title of notification. See https://docs.ntfy.sh/publish/#message-title |
... |
Additional arguments passed to |
Requirements
This progression handler requires the ntfy package.
Examples
pkg <- "ntfy"
if (requireNamespace(pkg, quietly = TRUE)) {
## We need to specify a ntfy.sh topic that progress messages
## should be sent to. See help("ntfy_topic", package = "ntfy")
## for details
Sys.setenv(NTFY_TOPIC = "R-my-secret-topic")
handlers("ntfy")
with_progress({ y <- slow_sum(1:10) })
print(y)
}
[Package progressr version 0.15.1 Index]