ntfy_done {ntfy} | R Documentation |
Notify Completion of a Process
Description
Notify Completion of a Process
Usage
ntfy_done(
x,
message = paste0("Process completed at ", Sys.time()),
title = "ntfy_done()",
tags = "white_check_mark",
topic = ntfy_topic(),
server = ntfy_server(),
auth = ntfy_auth(),
username = ntfy_username(),
password = ntfy_password(),
...
)
Arguments
x |
a result (ignored) |
message |
text to send as notification |
title |
title of notification. See https://docs.ntfy.sh/publish/#message-title |
tags |
text tags or emoji shortcodes from https://docs.ntfy.sh/emojis/, provided as a list |
topic |
subscribed topic to which to send notification |
server |
ntfy server |
auth |
logical indicating if the topic requires password authorization |
username |
username with access to a protected topic. |
password |
password with access to a protected topic. |
... |
other arguments passed to |
Value
the input x (for further piping) plus a notification will be sent
Examples
# report that a process has completed
Sys.sleep(3) |> ntfy_done("Woke up")
[Package ntfy version 0.0.6 Index]