Skip to content

Commit

Permalink
FIX: Renamed handler_rpushbullet() argument device to devices
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikBengtsson committed Nov 6, 2024
1 parent 95e42cd commit ccd2afd
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: progressr
Version: 0.15.0-9001
Version: 0.15.0-9002
Title: An Inclusive, Unifying API for Progress Updates
Description: A minimal, unifying API for scripts and packages to report progress updates from anywhere including when using parallel processing. The package is designed such that the developer can to focus on what progress should be reported on without having to worry about how to present it. The end user has full control of how, where, and when to render these progress updates, e.g. in the terminal using utils::txtProgressBar(), cli::cli_progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beepr::beep(), or on a file system via the size of a file. Anyone can add additional, customized, progression handlers. The 'progressr' package uses R's condition framework for signaling progress updated. Because of this, progress can be reported from almost anywhere in R, e.g. from classical for and while loops, from map-reduce API:s like the lapply() family of functions, 'purrr', 'plyr', and 'foreach'. It will also work with parallel processing via the 'future' framework, e.g. future.apply::future_lapply(), furrr::future_map(), and 'foreach' with 'doFuture'. The package is compatible with Shiny applications.
Authors@R: c(person("Henrik", "Bengtsson",
Expand Down
4 changes: 3 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Version (development version)

* ...
## Bug Fixes

* Renamed `handler_rpushbullet()` argument `device` to `devices`.


# Version 0.15.0 [2023-10-28]
Expand Down
4 changes: 2 additions & 2 deletions R/handler_rpushbullet.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' from the computer where this progress handler is registered.
#'
#' @export
handler_rpushbullet <- function(intrusiveness = getOption("progressr.intrusiveness.rpushbullet", 5), target = "gui", ..., title = "Progress update from R", recipients = NULL, email = NULL, channel = NULL, apikey = NULL, device = NULL) {
handler_rpushbullet <- function(intrusiveness = getOption("progressr.intrusiveness.rpushbullet", 5), target = "gui", ..., title = "Progress update from R", recipients = NULL, email = NULL, channel = NULL, apikey = NULL, devices = NULL) {
## Used for package testing purposes only when we want to perform
## everything except the last part where the backend is called
pbPost <- function(...) NULL
Expand All @@ -42,7 +42,7 @@ handler_rpushbullet <- function(intrusiveness = getOption("progressr.intrusivene
if (!is.null(email)) args$email <- email
if (!is.null(channel)) args$channel <- channel
if (!is.null(apikey)) args$apikey <- apikey
if (!is.null(device)) args$device <- device
if (!is.null(devices)) args$devices <- devices

do.call(pbPost, args = args)
}
Expand Down
7 changes: 6 additions & 1 deletion man/handler_rpushbullet.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ccd2afd

Please sign in to comment.