Add support for progressor(along = ...)

Author: HenrikBengtsson

.Rbuildignore

@@ -60,3 +60,4 @@ Rplots.pdf$
 ^last.dump*
 
 vignettes/
+^*.gif$

NEWS

@@ -1,9 +1,11 @@
 Package: progressr
 ==================
 
-Version: 0.1.3-9000 [2019-07-01]
+Version: 0.1.3-9000 [2019-07-02]
 
- * ...
+NEW FEATURES:
+
+ * Add support for progressor(along = ...).
 
 
 Version: 0.1.3 [2019-07-01]

R/progressor.R

@@ -2,6 +2,8 @@
 #'
 #' @param steps (integer) Maximum number of steps.
 #'
+#' @param along (vector; alternative) Corresponds to `steps = seq_along(along)`.
+#'
 #' @param label (character) A label.
 #'
 #' @param initiate (logical) If TRUE, the progressor will signal a
@@ -16,7 +18,12 @@
 progressor <- local({
   progressor_count <- 0L
 
-  function(steps, label = NA_character_, initiate = TRUE, auto_finish = TRUE) {
+  function(steps = NULL, along = NULL, label = NA_character_, initiate = TRUE, auto_finish = TRUE) {
+    stop_if_not(!is.null(steps) || !is.null(along))
+    if (!is.null(along)) steps <- length(along)
+    stop_if_not(length(steps) == 1L, is.numeric(steps), !is.na(steps),
+                steps >= 0)
+    
     label <- as.character(label)
     stop_if_not(length(label) == 1L)
 

R/slow_sum.R

@@ -16,7 +16,7 @@
 #'
 #' @export
 slow_sum <- function(x, delay = getOption("progressr.delay", 1.0), stdout = FALSE, message = TRUE) {
-  progress <- progressor(length(x))
+  progress <- progressor(along = x)
 
   sum <- 0
   for (kk in seq_along(x)) {

man/progressor.Rd

@@ -15,7 +15,7 @@ x <- 1:10
 message("progress_handler() ...")
 
 with_progress({
-  progress <- progressor(length(x))
+  progress <- progressor(along = x)
   for (ii in x) {
     Sys.sleep(delay)
     progress(message = sprintf("(%s)", paste(letters[1:ii], collapse="")))

tests/progress_handler.R

@@ -14,7 +14,7 @@ x <- 1:10
 
 message("progress_handler() ...")
 with_progress({
-  progress <- progressor(length(x))
+  progress <- progressor(along = x)
   for (ii in x) {
     Sys.sleep(delay)
     progress(message = sprintf("(%s)", paste(letters[1:ii], collapse="")))