DEPRECATION: Phasing out progress() [#113]

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: progressr
-Version: 0.7.0-9000
+Version: 0.7.0-9001
 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() or progress::progress_bar(), in a graphical user interface using utils::winProgressBar(), tcltk::tkProgressBar() or shiny::withProgress(), via the speakers using beep::beepr(), 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 APIs 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(

NEWS

@@ -1,7 +1,7 @@
 Package: progressr
 ==================
 
-Version: 0.7.0-9000 [2021-04-25]
+Version: 0.7.0-9001 [2021-05-15]
 
 SIGNIFICANT CHANGES:
 
@@ -24,6 +24,14 @@ BUG FIXES:
    value = fcn, envir = envir) : cannot change value of locked binding for
    '...progressor'.
 
+DEPRECATED AND DEFUNCT:
+
+ * Function progress() is deprecated in order to re-use it for other purpose.
+   It is unlikely that anyone really used this function, but if you did, then
+   use cond <- progression() to create 'progression' condition and then use
+   withRestart(signalCondition(cond), muffleProgression = function(p) NULL)
+   to signal it.
+   
 
 Version: 0.7.0 [2020-12-11]
 

R/progress.R

@@ -7,12 +7,14 @@
 #' @return A [base::condition] of class `progression`.
 #'
 #' @seealso
+#' To create a progression condition, use [progression()].
 #' To signal a progression condition, use [base::signalCondition()].
-#' To create and signal a progression condition at once, use [progress()].
 #'
 #' @keywords internal
 #' @export
 progress <- function(..., call = sys.call()) {
+  .Deprecated(msg = "progress() is deprecated", package = .packageName)
+  
   args <- list(...)
   if (length(args) == 1L && inherits(args[[1L]], "condition")) {
     cond <- args[[1L]]

R/progression.R

@@ -40,7 +40,6 @@
 #'
 #' @seealso
 #' To signal a progression condition, use [base::signalCondition()].
-#' To create and signal a progression condition at once, use [progress()].
 #'
 #' @keywords internal
 #' @export

R/progressor.R

@@ -79,12 +79,20 @@ progressor <- local({
 
     fcn <- function(message = character(0L), ..., type = "update") {
       progression_index <<- progression_index + 1L
-      progress(type = type,
-               message = message,
-               ...,
-               progressor_uuid = progressor_uuid,
-               progression_index = progression_index,
-               owner_session_uuid = owner_session_uuid)
+      cond <- progression(
+        type = type,
+        message = message,
+        ...,
+        progressor_uuid = progressor_uuid,
+        progression_index = progression_index,
+        owner_session_uuid = owner_session_uuid,
+        call = sys.call()
+      )
+      withRestarts(
+        signalCondition(cond),
+        muffleProgression = function(p) NULL
+      )
+      invisible(cond)
     }
     formals(fcn)$message <- message
     class(fcn) <- c("progressor", class(fcn))

inst/WORDLIST

@@ -67,3 +67,8 @@ RStudio
 BiocParallel
 bplapply
 txtprogressbar
+cond
+envir
+fcn
+signalCondition
+md