cleanup

Author: HenrikBengtsson

DESCRIPTION

@@ -18,14 +18,14 @@ Suggests:
     progress,
     foreach,
     purrr,
-    future (>= 1.15.1),
+    future (>= 1.16.0),
     doFuture,
     future.apply,
     furrr,
     shiny,
     notifier
 Remotes:
-  gaborcsardi/notifier@d92b1b6
+  gaborcsardi/notifier@62d484
 URL: https://github.com/HenrikBengtsson/progressr
 BugReports: https://github.com/HenrikBengtsson/progressr/issues
 RoxygenNote: 7.0.2

OVERVIEW.md

@@ -12,11 +12,11 @@ Design motto:
 
 ## Two Minimal APIs
 
- | Developer's API       | End-user's API              |
- |-----------------------|-----------------------------|
- | `p <- progressor(n)`  | `with_progress(expr)`       |
- | `p(msg, ...)`         | `handlers(...)`             |
- |                       | `options(progressr.*=...)`  |
+ | Developer's API               | End-user's API              |
+ |-------------------------------|-----------------------------|
+ | `p <- progressor(n)`          | `with_progress(expr)`       |
+ | `p <- progressor(along = x)`  | `handlers(...)`             |
+ | `p(msg, ...)`                 | `options(progressr.*=...)`  |
 
 
 
@@ -26,12 +26,12 @@ Assume that we have a function `slow_sum()` for adding up the values in a vector
 
 ```r
 slow_sum <- function(x) {
-  progress <- progressr::progressor(along = x)
+  p <- progressr::progressor(along = x)
   sum <- 0
   for (kk in seq_along(x)) {
     Sys.sleep(0.1)
     sum <- sum + x[kk]
-    progress(message = sprintf("Added %g", x[kk]))
+    p(message = sprintf("Added %g", x[kk]))
   }
   sum
 }

R/options.R

@@ -57,7 +57,7 @@
 #' @section Options for progressr examples and demos:
 #'
 #' \describe{
-#'  \item{\option{progressr.delay}:}{(numeric) Delay (in seconds) between each iteration of [slow_sum()]. (Default: `1.0`)}
+#'  \item{\option{progressr.demo.delay}:}{(numeric) Delay (in seconds) between each iteration of [slow_sum()]. (Default: `1.0`)}
 #' }
 #'
 #'
@@ -67,7 +67,7 @@
 #' @aliases
 #' progressr.clear
 #' progressr.debug
-#' progressr.delay
+#' progressr.demo.delay
 #' progressr.delay_stdout progressr.delay_conditions
 #' progressr.enable progressr.enable_after
 #' progressr.interval

R/progressor_plyr.R R/progress_plyr.RR/progressor_plyr.R renamed to R/progress_plyr.R

@@ -1,4 +1,4 @@
-#' Create a Progressor Function
+#' Create a Progressor Function which Signals Progress Updates
 #'
 #' @param steps (integer) Number of progressing steps.
 #'
@@ -15,7 +15,7 @@
 #' @param label (character) A label.
 #'
 #' @param initiate (logical) If TRUE, the progressor will signal a
-#' [progression] 'initiate' condition.
+#' [progression] 'initiate' condition when created.
 #'
 #' @param auto_finish (logical) If TRUE, then the progressor will signal a
 #' [progression] 'finish' condition as soon as the last step has been reached.

R/progressor.R

@@ -15,7 +15,7 @@
 #' This function signals [progression] conditions as it progresses.
 #'
 #' @export
-slow_sum <- function(x, delay = getOption("progressr.delay", 1.0), stdout = FALSE, message = TRUE) {
+slow_sum <- function(x, delay = getOption("progressr.demo.delay", 1.0), stdout = FALSE, message = TRUE) {
   progress <- progressor(along = x)
 
   sum <- 0

R/slow_sum.R

@@ -24,7 +24,7 @@
 #'
 #' @example incl/with_progress.R
 #'
-#' @details
+#' @section Progression handler functions:
 #' Formally, progression handlers are calling handlers that are called
 #' when a [progression] condition is signaled.  These handlers are functions
 #' that takes one argument which is the [progression] condition.

R/with_progress.R

@@ -1,9 +1,8 @@
-#' Evaluate Expression while Ignoring All Progress Updates
-#'
-#' @param expr An \R expression to evaluate.
-#'
-#' @return Return nothing (reserved for future usage).
+#' @details
+#' `without_progress()` evaluates an expression while ignoring all
+#' progress updates.
 #'
+#' @rdname with_progress
 #' @export
 without_progress <- function(expr) {
   withCallingHandlers(expr, progression = function(p) {

R/without_progress.R

@@ -1,5 +1,5 @@
 .onLoad <- function(libname, pkgname) {
   if (in_r_cmd_check()) {
-    options(progressr.delay = 0.01)
+    options(progressr.demo.delay = 0.01)
   }
 }

R/zzz.R

@@ -14,11 +14,11 @@ Design motto:
 
 ## Two Minimal APIs
 
- | Developer's API       | End-user's API              |
- |-----------------------|-----------------------------|
- | `p <- progressor(n)`  | `with_progress(expr)`       |
- | `p(msg, ...)`         | `handlers(...)`             |
- |                       | `options(progressr.*=...)`  |
+ | Developer's API               | End-user's API              |
+ |-------------------------------|-----------------------------|
+ | `p <- progressor(n)`          | `with_progress(expr)`       |
+ | `p <- progressor(along = x)`  | `handlers(...)`             |
+ | `p(msg, ...)`                 | `options(progressr.*=...)`  |
 
 
 
@@ -28,12 +28,12 @@ Assume that we have a function `slow_sum()` for adding up the values in a vector
 
 ```r
 slow_sum <- function(x) {
-  progress <- progressr::progressor(along = x)
+  p <- progressr::progressor(along = x)
   sum <- 0
   for (kk in seq_along(x)) {
     Sys.sleep(0.1)
     sum <- sum + x[kk]
-    progress(message = sprintf("Added %g", x[kk]))
+    p(message = sprintf("Added %g", x[kk]))
   }
   sum
 }