Merge branch 'release/0.15.1'

.github/workflows/R-CMD-check.yaml

@@ -22,11 +22,13 @@ jobs:
 #          - {os: macOS-latest,   r: 'release'  }
 #          - {os: macOS-latest,   r: 'oldrel'   }
           - {os: ubuntu-latest,  r: 'devel'    }
+          - {os: ubuntu-latest,  r: 'devel'    , suggests_only: 'false', label: '!suggests_only' }
           - {os: ubuntu-latest,  r: 'release'  }
           - {os: ubuntu-latest,  r: 'oldrel'   }
           - {os: ubuntu-latest,  r: 'oldrel-1' }
           - {os: ubuntu-latest,  r: 'oldrel-2' }
-          - {os: ubuntu-latest,  r: '3.6'      }
+          - {os: ubuntu-latest,  r: '4.1'      }
+#          - {os: ubuntu-latest,  r: '3.6'      } ## optional 'ntfy' requires R (>= 4.1), but triggers an error
           - {os: ubuntu-latest,  r: 'release'  , language: ko,    label: ko    }
           - {os: ubuntu-latest,  r: 'release'  , language: zh_CN, label: zh_CN }
           - {os: ubuntu-latest,  r: 'release'  , language: zh_TW, label: zh_TW }
@@ -37,9 +39,9 @@ jobs:
       ## Test in other locale (optional)
       LANGUAGE: ${{ matrix.config.language }}
       ## R CMD check
+      _R_CHECK_SUGGESTS_ONLY_: ${{ matrix.config.suggests_only || 'true' }}
       _R_CHECK_CRAN_INCOMING_: false
       _R_CHECK_MATRIX_DATA_: true
-      _R_CHECK_SUGGESTS_ONLY_: true
       _R_CHECK_THINGS_IN_TEMP_DIR_: true
       ## R (>= 4.4.0) Note, no trailing underscore (sic!)
       _R_COMPARE_LANG_OBJECTS: eqonly
@@ -81,6 +83,10 @@ jobs:
           cat(sprintf("LANGUAGE=%s\n", sQuote(Sys.getenv("LANGUAGE"))))
           cat(sprintf("locales: %s\n", sQuote(Sys.getlocale())))
           tryCatch(log("a"), error = conditionMessage)
+          cat("R-specific environment variables:\n")
+          envs <- Sys.getenv()
+          envs <- envs[grep("^(_R_|R_)", names(envs))]
+          print(envs)
         shell: Rscript {0}
 
       - name: Check (!Windows)

.github/workflows/rhub.yaml

@@ -60,6 +60,10 @@ jobs:
         with:
           token: ${{ secrets.RHUB_TOKEN }}
           job-config: ${{ matrix.config.job-config }}
+      - name: Install itself (to build vignettes)
+        run: |
+          install.packages(".", repos=NULL, type="source")
+        shell: Rscript {0}
       - uses: r-hub/actions/run-check@v1
         with:
           token: ${{ secrets.RHUB_TOKEN }}
@@ -89,6 +93,10 @@ jobs:
         with:
           job-config: ${{ matrix.config.job-config }}
           token: ${{ secrets.RHUB_TOKEN }}
+      - name: Install itself (to build vignettes)
+        run: |
+          install.packages(".", repos=NULL, type="source")
+        shell: Rscript {0}
       - uses: r-hub/actions/run-check@v1
         with:
           job-config: ${{ matrix.config.job-config }}

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: progressr
-Version: 0.15.0
+Version: 0.15.1
 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",
@@ -27,6 +27,7 @@ Suggests:
     future,
     future.apply,
     furrr,
+    ntfy,
     RPushbullet,
     rstudioapi,
     shiny,

NEWS.md

@@ -1,4 +1,13 @@
-# Version 0.15.0 [2023-10-28]
+# Version 0.15.1 [2024-11-20]
+
+## Bug Fixes
+
+ * Renamed `handler_rpushbullet()` argument `device` to `devices`.
+
+ * Fixed thinko bug in `example("handler_ntfy")`.
+
+
+# Version 0.15.0 [2024-10-28]
 
 ## New Features
 

R/handler_notifier.R

@@ -13,7 +13,6 @@
 #' available from <https://github.com/gaborcsardi/notifier>.  This can be
 #' installed as `remotes::install_github("gaborcsardi/notifier@62d484")`.
 #'
-#' @keywords internal
 #' @export
 handler_notifier <- function(intrusiveness = getOption("progressr.intrusiveness.notifier", 10), target = "gui", ...) {
   ## Used for package testing purposes only when we want to perform

R/handler_ntfy.R

@@ -1,6 +1,6 @@
 #' Progression Handler: Progress Reported via the Ntfy.sh Messaging Service
 #'
-#' A progression handler for `ntfy_send()` of the \pkg{ntfy} package,
+#' A progression handler for [ntfy::ntfy_send()] of the \pkg{ntfy} package,
 #' which sends notifications via the <https://ntfy.sh> framework.
 #'
 #' @inheritParams make_progression_handler
@@ -11,10 +11,8 @@
 #' @example incl/handler_ntfy.R
 #'
 #' @section Requirements:
-#' This progression handler requires the \pkg{ntfy} package, which is only
-#' available from <https://github.com/jonocarroll/ntfy>.
+#' This progression handler requires the \pkg{ntfy} package.
 #'
-#' @keywords internal
 #' @export
 handler_ntfy <- function(intrusiveness = getOption("progressr.intrusiveness.ntfy", 5), target = "gui", ..., title = "Progress update from R") {
   ## Used for package testing purposes only when we want to perform

R/handler_rpushbullet.R

@@ -1,6 +1,7 @@
 #' Progression Handler: Progress Reported via the Pushbullet Messaging Service
 #'
-#' A progression handler for `pbPost()` of the \pkg{RPushbullet} package.
+#' A progression handler for [RPushbullet::pbPost()] of the \pkg{RPushbullet}
+#' package.
 #'
 #' @inheritParams make_progression_handler
 #' @inheritParams RPushbullet::pbPost
@@ -15,9 +16,8 @@
 #' of the \pkg{RPushbullet} package.  It also requires internet access
 #' from the computer where this progress handler is registered.
 #'
-#' @keywords internal
 #' @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
@@ -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)
   }

cran-comments.md

@@ -1,3 +0,0 @@
-I've verified this submission has no negative impact on any of the 110 reverse package dependencies available on CRAN (n = 107) and Bioconductor (n = 3).
-
-Thank you

incl/handler_ntfy.R

@@ -3,7 +3,7 @@ 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")
+  Sys.setenv(NTFY_TOPIC = "R-my-secret-topic")
 
   handlers("ntfy")
   with_progress({ y <- slow_sum(1:10) })

pkgdown/_pkgdown.yml.rsp

@@ -22,7 +22,7 @@ home:
   - text: The Futureverse Project
     href: https://www.futureverse.org/
   - text: Futureverse User Forum
-    href: https://github.com/HenrikBengtsson/future/discussions
+    href: https://github.com/futureverse/future/discussions
 
 navbar:
   structure: