README: Avoid promoting progressr.* options for now

Author: HenrikBengtsson

OVERVIEW.md

@@ -16,7 +16,7 @@ Design motto:
  |-------------------------------|-----------------------------|
  | `p <- progressor(n)`          | `with_progress(expr)`       |
  | `p <- progressor(along = x)`  | `handlers(...)`             |
- | `p(msg, ...)`                 | `options(progressr.*=...)`  |
+ | `p(msg, ...)`                 |                             |
 
 
 
@@ -75,7 +75,7 @@ This progress handler will present itself as:
 [==================>---------------------------]  40% Added 4
 ```
 
-To set the default progress handler(s) in all your R sessions, call `progressr::handlers(...)` in your <code>~/.Rprofile</code> file.  An alternative, which avoids loading the **progressr** package if never used, is to set `options(progressr.handlers = progress_handler)`.
+To set the default progress handler(s) in all your R sessions, call `progressr::handlers(...)` in your <code>~/.Rprofile</code> file.
 
 
 

R/zzz.R

@@ -1,5 +1,7 @@
 .onLoad <- function(libname, pkgname) {
   if (in_r_cmd_check()) {
-    options(progressr.demo.delay = 0.01)
+    msg <- sprintf("%s:::.onLoad(): Detected 'R CMD check'", pkgname)
+    packageStartupMessage(msg)
+    options(progressr.demo.delay = 0.0)
   }
 }

README.md

@@ -18,7 +18,7 @@ Design motto:
  |-------------------------------|-----------------------------|
  | `p <- progressor(n)`          | `with_progress(expr)`       |
  | `p <- progressor(along = x)`  | `handlers(...)`             |
- | `p(msg, ...)`                 | `options(progressr.*=...)`  |
+ | `p(msg, ...)`                 |                             |
 
 
 
@@ -77,7 +77,7 @@ This progress handler will present itself as:
 [==================>---------------------------]  40% Added 4
 ```
 
-To set the default progress handler(s) in all your R sessions, call `progressr::handlers(...)` in your <code>~/.Rprofile</code> file.  An alternative, which avoids loading the **progressr** package if never used, is to set `options(progressr.handlers = progress_handler)`.
+To set the default progress handler(s) in all your R sessions, call `progressr::handlers(...)` in your <code>~/.Rprofile</code> file.
 
 
 

incl/debug_handler.R

@@ -1,3 +1,8 @@
+res <- progressr:::query_r_cmd_check()
+print(res)
+str(res)
+print(getOption("progressr.demo.delay", NA_real_))
+
 handlers("debug")
 with_progress({ y <- slow_sum(1:10) })
 print(y)

man/debug_handler.Rd

@@ -15,6 +15,7 @@ mdebug <- progressr:::mdebug
 mprint <- progressr:::mprint
 mprintf <- progressr:::mprintf
 mstr <- progressr:::mstr
+query_r_cmd_check <- progressr:::query_r_cmd_check
 in_r_cmd_check <- progressr:::in_r_cmd_check
 stop_if_not <- progressr:::stop_if_not
 printf <- function(...) cat(sprintf(...))

tests/incl/start,load-only.R

@@ -89,6 +89,20 @@ print(TRUE %||% FALSE)
 
 message("*** %||% ... done")
 
+message("*** query_r_cmd_check() ...")
+
+print(query_r_cmd_check())
+
+cat("Command line arguments:\n")
+args <- commandArgs()
+print(args)
+
+cat("Working directory:\n")
+pwd <- getwd()
+print(pwd)
+
+message("*** query_r_cmd_check() ... done")
+
 message("*** in_r_cmd_check() ...")
 
 print(in_r_cmd_check())