Now option 'progressr.interval' defaults to 0.0

Author: HenrikBengtsson

NEWS

@@ -1,12 +1,14 @@
 Package: progressr
 ==================
 
-Version: 0.1.1-9000 [2019-06-13]
+Version: 0.1.1-9000 [2019-06-14]
 
 NEW FEATURES:
 
  * with_progress() gained arguments 'enable' and 'interval' as an alternative
    to setting corresponding options progressr.*.
+
+ * Now option 'progressr.interval' defaults to 0.0 (was 0.5 seconds).
 
 
 Version: 0.1.1 [2019-06-08]

R/progression_handler.R

@@ -28,7 +28,7 @@
 #' @return A function of class `progression_handler`.
 #'
 #' @export
-progression_handler <- function(name, reporter = list(), handler = NULL, enable = getOption("progressr.enable", interactive()), enable_after = getOption("progressr.enable_after", 0.0), times = getOption("progressr.times", +Inf), interval = getOption("progressr.interval", 0.5), intrusiveness = 1.0, clear = getOption("progressr.clear", TRUE)) {
+progression_handler <- function(name, reporter = list(), handler = NULL, enable = getOption("progressr.enable", interactive()), enable_after = getOption("progressr.enable_after", 0.0), times = getOption("progressr.times", +Inf), interval = getOption("progressr.interval", 0.0), intrusiveness = 1.0, clear = getOption("progressr.clear", TRUE)) {
   if (!enable) times <- 0
   name <- as.character(name)
   stop_if_not(length(name) == 1L, !is.na(name), nzchar(name))

R/slow_sum.R

@@ -18,14 +18,14 @@
 slow_sum <- function(x, delay = getOption("delay", 0.05), stdout = FALSE, message = FALSE) {
   progress <- progressor(length(x))
 
-  res <- 0
+  sum <- 0
   for (kk in seq_along(x)) {
     if (stdout) cat(sprintf("O: Element #%d\n", kk))
     Sys.sleep(delay)
-    res <- res + x[kk]
+    sum <- sum + x[kk]
     progress(message = sprintf("P: Adding %g", kk))
     if (message) message(sprintf("M: Added value %g", x[kk]))
   }
 
-  res
+  sum
 }

README.md

@@ -14,13 +14,13 @@ Assume that we have a function `slow_sum()` for adding up the values in a vector
 ```r
 slow_sum <- function(x) {
   progress <- progressr::progressor(length(x))
-  res <- 0
+  sum <- 0
   for (kk in seq_along(x)) {
     Sys.sleep(0.1)
-    res <- res + x[kk]
-    progress()
+    sum <- sum + x[kk]
+    progress(message = sprintf("Added %g", x[kk]))
   }
-  res
+  sum
 }
 ```