ntfy_done_with_timing {ntfy}R Documentation

Notify Completion of a Process with Timing

Description

Notify Completion of a Process with Timing

Usage

ntfy_done_with_timing(
  x,
  message = paste0("Process completed in ", time_result, "s"),
  title = "ntfy_done_with_timing()",
  tags = "stopwatch",
  topic = ntfy_topic(),
  server = ntfy_server(),
  auth = ntfy_auth(),
  username = ntfy_username(),
  password = ntfy_password(),
  ...
)

Arguments

x

expression to be evaluated and timed

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

Value

the result of evaluating x (for further piping) plus a notification will be sent

Examples


# report that a process has completed, and how long it took
Sys.sleep(3) |> ntfy_done_with_timing()


[Package ntfy version 0.0.6 Index]