Merge branch 'release/0.2.0'

Author: HenrikBengtsson

CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: progressr
-Version: 0.1.5
+Version: 0.2.0
 Title: A Unifying API for Progress Updates
 Description: A minimal API for reporting progress updates upstream.  The design is to separate the representation of progress updates from how they are presented.  What type of progress to signal is controlled by the developer.  How these progress updates are rendered is controlled by the end user.  For instance, some users may prefer visual feedback such as a horizontal progress bar in the terminal, whereas others may prefer auditory feedback.
 Authors@R: c(
@@ -13,18 +13,18 @@ Suggests:
     graphics,
     tcltk,
     beepr,
-    notifier,
     pbmcapply,
     plyr,
     progress,
-    future,
+    future (>= 1.15.1),
     doFuture,
     future.apply,
     furrr,
-    shiny
+    shiny,
+    notifier
 Remotes:
   gaborcsardi/notifier@d92b1b6
 URL: https://github.com/HenrikBengtsson/progressr
 BugReports: https://github.com/HenrikBengtsson/progressr/issues
-RoxygenNote: 6.1.1
+RoxygenNote: 7.0.2
 Roxygen: list(markdown = TRUE)

NAMESPACE

@@ -23,7 +23,7 @@ export(slow_sum)
 export(tkprogressbar_handler)
 export(txtprogressbar_handler)
 export(winprogressbar_handler)
-export(withProgress2)
+export(withProgressShiny)
 export(with_progress)
 export(without_progress)
 importFrom(digest,digest)

NEWS

@@ -1,6 +1,18 @@
 Package: progressr
 ==================
 
+Version: 0.2.0 [2020-01-04]
+
+SIGNIFICANT CHANGES:
+
+ * Renamed  withProgress2() to withProgressShiny().
+
+NEW FEATURES:
+
+ * handlers() gained argument 'default' specifying a progression handler to
+   be returned if none is set.
+
+
 Version: 0.1.5 [2019-10-26]
 
 NEW FEATURES:

R/handlers.R

@@ -10,6 +10,9 @@
 #' is produces and the missing handlers is ignored.  If `"ignore"`, the
 #' missing handlers is ignored.
 #'
+#' @param default The default progression calling handler to use if none
+#' are set.
+#'
 #' @return (invisibly) the previous list of progression handlers set.
 #' If no arguments are specified, then the current set of progression
 #' handlers is returned.
@@ -21,11 +24,11 @@
 #' @example incl/handlers.R
 #'
 #' @export
-handlers <- function(..., on_missing = c("error", "warning", "ignore")) {
+handlers <- function(..., on_missing = c("error", "warning", "ignore"), default = txtprogressbar_handler) {
   args <- list(...)
 
   ## Get the current set of progression handlers?
-  if (length(args) == 0L) return(getOption("progressr.handlers"))
+  if (length(args) == 0L) return(getOption("progressr.handlers", default))
 
   on_missing <- match.arg(on_missing)
 

R/progression_handler.R

@@ -29,14 +29,17 @@
 #' @param clear (logical) If TRUE, any output, typically visual, produced
 #'   by a reporter will be cleared/removed upon completion, if possible.
 #'
+#' @param target (character vector) Specifies where progression updates are
+#'   rendered.
+#'
 #' @return A function of class `progression_handler` that takes a
 #' [progression] condition as its first and only argument.
 #'
 #' @seealso
 #' [base::withCallingHandlers()].
 #'
 #' @export
-make_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)) {
+make_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), target = "terminal") {
   if (!enable) times <- 0
   name <- as.character(name)
   stop_if_not(length(name) == 1L, !is.na(name), nzchar(name))
@@ -50,7 +53,8 @@ make_progression_handler <- function(name, reporter = list(), handler = NULL, en
               times >= 0)
   stop_if_not(length(interval) == 1L, is.numeric(interval),
               !is.na(interval), interval >= 0)
-
+  stop_if_not(is.character(target))
+  
   ## Disable progress updates?
   if (times == 0 || is.infinite(interval) || is.infinite(intrusiveness)) {
     handler <- function(p) NULL
@@ -101,7 +105,8 @@ make_progression_handler <- function(name, reporter = list(), handler = NULL, en
       interval = interval,
       enable_after = enable_after,
       auto_finish = auto_finish,
-      clear = clear
+      clear = clear,
+      target = target
     )
 
     state <- list(
@@ -327,7 +332,7 @@ make_progression_handler <- function(name, reporter = list(), handler = NULL, en
   class(handler) <- c(sprintf("%s_progression_handler", name),
                       "progression_handler", "calling_handler",
 		      class(handler))
-
+		      
   handler
 }
 
@@ -348,6 +353,7 @@ print.progression_handler <- function(x, ...) {
   s <- c(s, sprintf("   - intrusiveness: %g", env$intrusiveness))
   s <- c(s, sprintf("   - auto_finish: %s", env$auto_finish))
   s <- c(s, sprintf("   - clear: %s", env$clear))
+  s <- c(s, sprintf("   - target: %s", paste(sQuote(env$target), collapse = ", ")))
   s <- c(s, sprintf("   - milestones: %s", hpaste(env$milestones %||% "<NULL>")))
   s <- c(s, sprintf("   - owner: %s", hpaste(env$owner %||% "<NULL>")))
 

R/progression_handlers.R

@@ -14,7 +14,7 @@
 #' @example incl/ascii_alert_handler.R
 #'
 #' @export
-ascii_alert_handler <- function(symbol = "\a", file = stderr(), intrusiveness = getOption("progressr.intrusiveness.auditory", 5.0), ...) {
+ascii_alert_handler <- function(symbol = "\a", file = stderr(), intrusiveness = getOption("progressr.intrusiveness.auditory", 5.0), target = c("terminal", "audio"), ...) {
   reporter <- local({
     list(
       update = function(config, state, progression, ...) {
@@ -44,7 +44,7 @@ ascii_alert_handler <- function(symbol = "\a", file = stderr(), intrusiveness =
 #'
 #' @importFrom utils file_test flush.console txtProgressBar setTxtProgressBar
 #' @export
-txtprogressbar_handler <- function(style = 3L, file = stderr(), intrusiveness = getOption("progressr.intrusiveness.terminal", 1), ...) {
+txtprogressbar_handler <- function(style = 3L, file = stderr(), intrusiveness = getOption("progressr.intrusiveness.terminal", 1), target = "terminal", ...) {
   reporter <- local({
     ## Import functions
     eraseTxtProgressBar <- function(pb) {
@@ -123,7 +123,7 @@ txtprogressbar_handler <- function(style = 3L, file = stderr(), intrusiveness =
 #' @example incl/tkprogressbar_handler.R
 #'
 #' @export
-tkprogressbar_handler <- function(intrusiveness = getOption("progressr.intrusiveness.gui", 1), ...) {
+tkprogressbar_handler <- function(intrusiveness = getOption("progressr.intrusiveness.gui", 1), target = "terminal", ...) {
   ## Used for package testing purposes only when we want to perform
   ## everything except the last part where the backend is called
   if (!is_fake("tkprogressbar_handler")) {
@@ -190,7 +190,7 @@ tkprogressbar_handler <- function(intrusiveness = getOption("progressr.intrusive
 #' @param \ldots Additional arguments passed to [make_progression_handler()].
 #'
 #' @export
-winprogressbar_handler <- function(intrusiveness = getOption("progressr.intrusiveness.gui", 1), ...) {
+winprogressbar_handler <- function(intrusiveness = getOption("progressr.intrusiveness.gui", 1), target = "gui", ...) {
   ## Used for package testing purposes only when we want to perform
   ## everything except the last part where the backend is called
   if (!is_fake("winprogressbar_handler")) {
@@ -268,7 +268,7 @@ winprogressbar_handler <- function(intrusiveness = getOption("progressr.intrusiv
 #'
 #' @importFrom utils file_test flush.console txtProgressBar setTxtProgressBar
 #' @export
-pbmcapply_handler <- function(substyle = 3L, style = "ETA", file = stderr(), intrusiveness = getOption("progressr.intrusiveness.terminal", 1), ...) {
+pbmcapply_handler <- function(substyle = 3L, style = "ETA", file = stderr(), intrusiveness = getOption("progressr.intrusiveness.terminal", 1), target = "terminal", ...) {
   if (!is_fake("pbmcapply_handler")) {
     progressBar <- pbmcapply::progressBar
     eraseTxtProgressBar <- function(pb) {
@@ -366,7 +366,7 @@ pbmcapply_handler <- function(substyle = 3L, style = "ETA", file = stderr(), int
 #' @example incl/progress_handler.R
 #'
 #' @export
-progress_handler <- function(format = "[:bar] :percent :message", show_after = 0.0, intrusiveness = getOption("progressr.intrusiveness.terminal", 1), ...) {
+progress_handler <- function(format = "[:bar] :percent :message", show_after = 0.0, intrusiveness = getOption("progressr.intrusiveness.terminal", 1), target = "terminal", ...) {
   if (!is_fake("progress_handler")) {
     progress_bar <- progress::progress_bar
   } else {
@@ -440,7 +440,7 @@ progress_handler <- function(format = "[:bar] :percent :message", show_after = 0
 #' @example incl/beepr_handler.R
 #'
 #' @export
-beepr_handler <- function(initiate = 2L, update = 10L,  finish = 11L, intrusiveness = getOption("progressr.intrusiveness.auditory", 5.0), ...) {
+beepr_handler <- function(initiate = 2L, update = 10L,  finish = 11L, intrusiveness = getOption("progressr.intrusiveness.auditory", 5.0), target = "audio", ...) {
   ## Used for package testing purposes only when we want to perform
   ## everything except the last part where the backend is called
   if (!is_fake("beepr_handler")) {
@@ -491,7 +491,7 @@ beepr_handler <- function(initiate = 2L, update = 10L,  finish = 11L, intrusiven
 #' @example incl/notifier_handler.R
 #'
 #' @export
-notifier_handler <- function(intrusiveness = getOption("progressr.intrusiveness.notifier", 10), ...) {
+notifier_handler <- function(intrusiveness = getOption("progressr.intrusiveness.notifier", 10), target = "gui", ...) {
   ## Used for package testing purposes only when we want to perform
   ## everything except the last part where the backend is called
   if (!is_fake("notifier_handler")) {
@@ -548,7 +548,7 @@ notifier_handler <- function(intrusiveness = getOption("progressr.intrusiveness.
 #' @example incl/debug_handler.R
 #'
 #' @export
-debug_handler <- function(interval = getOption("progressr.interval", 0), intrusiveness = getOption("progressr.intrusiveness.debug", 0), ...) {
+debug_handler <- function(interval = getOption("progressr.interval", 0), intrusiveness = getOption("progressr.intrusiveness.debug", 0), target = "terminal", ...) {
   reporter <- local({
     t_init <- NULL
 
@@ -599,7 +599,7 @@ debug_handler <- function(interval = getOption("progressr.interval", 0), intrusi
 #' @param \ldots Additional arguments passed to [make_progression_handler()].
 #'
 #' @export
-newline_handler <- function(symbol = "\n", file = stderr(), intrusiveness = getOption("progressr.intrusiveness.debug", 0), ...) {
+newline_handler <- function(symbol = "\n", file = stderr(), intrusiveness = getOption("progressr.intrusiveness.debug", 0), target = "terminal", ...) {
   reporter <- local({
     list(
       initiate = function(...) cat(file = file, symbol),
@@ -630,7 +630,7 @@ newline_handler <- function(symbol = "\n", file = stderr(), intrusiveness = getO
 #'
 #' @importFrom utils file_test
 #' @export
-filesize_handler <- function(file = "default.progress", intrusiveness = getOption("progressr.intrusiveness.file", 5), ...) {
+filesize_handler <- function(file = "default.progress", intrusiveness = getOption("progressr.intrusiveness.file", 5), target = "file", ...) {
   reporter <- local({
     set_file_size <- function(config, state, progression) {
       ratio <- state$step / config$max_steps
@@ -696,7 +696,7 @@ filesize_handler <- function(file = "default.progress", intrusiveness = getOptio
 #' }}
 #'
 #' @export
-shiny_handler <- function(intrusiveness = getOption("progressr.intrusiveness.gui", 1), ...) {
+shiny_handler <- function(intrusiveness = getOption("progressr.intrusiveness.gui", 1), target = "gui", ...) {
   reporter <- local({
     list(
       update = function(config, state, progression, ...) {

R/withProgress2.R R/withProgressShiny.RR/withProgress2.R renamed to R/withProgressShiny.R

@@ -6,10 +6,10 @@
 #'
 #' @return The value of `[shiny::withProgress]`.
 #'
-#' @example incl/shiny-withProgress.R
+#' @example incl/withProgressShiny.R
 #'
 #' @export
-withProgress2 <- function(expr, ..., env = parent.frame(), quoted = FALSE, handlers = c(shiny = shiny_handler, getOption("progressr.handlers"))) {
+withProgressShiny <- function(expr, ..., env = parent.frame(), quoted = FALSE, handlers = c(shiny = shiny_handler, progressr::handlers(default = NULL))) {
   if (!quoted) expr <- substitute(expr)
   expr <- bquote(progressr::with_progress({.(expr)}, handlers = .(handlers)))
   res <- withVisible(shiny::withProgress(expr, ..., env = env, quoted = TRUE))

R/with_progress.R

@@ -25,7 +25,7 @@
 #' @example incl/with_progress.R
 #'
 #' @export
-with_progress <- function(expr, handlers = getOption("progressr.handlers", txtprogressbar_handler), cleanup = TRUE, delay_stdout = getOption("progressr.delay_stdout", interactive()), delay_conditions = getOption("progressr.delay_conditions", if (interactive()) c("condition") else character(0L)), interval = NULL, enable = NULL) {
+with_progress <- function(expr, handlers = progressr::handlers(), cleanup = TRUE, delay_stdout = getOption("progressr.delay_stdout", interactive()), delay_conditions = getOption("progressr.delay_conditions", if (interactive()) c("condition") else character(0L)), interval = NULL, enable = NULL) {
   stop_if_not(is.logical(cleanup), length(cleanup) == 1L, !is.na(cleanup))
 
   ## FIXME: With zero handlers, progression conditions will be

README.md

@@ -339,5 +339,5 @@ Contributing to this package is easy.  Just send a [pull request](https://help.g
 | Resource:     | GitHub        | Travis CI       | AppVeyor         |
 | ------------- | ------------------- | --------------- | ---------------- |
 | _Platforms:_  | _Multiple_          | _Linux & macOS_ | _Windows_        |
-| R CMD check   |  | <a href="https://travis-ci.org/HenrikBengtsson/progressr"><img src="https://travis-ci.org/HenrikBengtsson/progressr.svg" alt="Build status"></a>   |  |
+| R CMD check   |  | <a href="https://travis-ci.org/HenrikBengtsson/progressr"><img src="https://travis-ci.org/HenrikBengtsson/progressr.svg" alt="Build status"></a>   | <a href="https://ci.appveyor.com/project/HenrikBengtsson/progressr"><img src="https://ci.appveyor.com/api/projects/status/github/HenrikBengtsson/progressr?svg=true" alt="Build status"></a> |
 | Test coverage |                     | <a href="https://codecov.io/gh/HenrikBengtsson/progressr"><img src="https://codecov.io/gh/HenrikBengtsson/progressr/branch/develop/graph/badge.svg" alt="Coverage Status"/></a>     |                  |