Use run_dontrun and run_donttest

Author: jimhester

NEWS.md

@@ -1,5 +1,7 @@
 # devtools (development version)
 
+* `run_examples()` arguments `run` and `test` are deprecated in favor of the (hopefully) more clear `run_dontrun` and `run_donttest` (pkgload/#107).
+
 # devtools 2.3.0
 
 * `build()` now errors with a more informative error message when passed an

R/run-examples.R

@@ -6,17 +6,14 @@
 #' making it possible to run all examples from an R function.
 #'
 #' @template devtools
+#' @inheritParams pkgload::run_example
 #' @param start Where to start running the examples: this can either be the
 #'   name of `Rd` file to start with (with or without extensions), or
 #'   a topic name. If omitted, will start with the (lexicographically) first
 #'   file. This is useful if you have a lot of examples and don't want to
 #'   rerun them every time you fix a problem.
 #' @family example functions
 #' @param show DEPRECATED.
-#' @param test if `TRUE`, code in \code{\\donttest{}} will be commented
-#'   out. If `FALSE`, code in \code{\\testonly{}} will be commented out.
-#' @param run if `FALSE`, code in \code{\\dontrun{}} will be commented
-#'   out.
 #' @param fresh if `TRUE`, will be run in a fresh R session. This has
 #'   the advantage that there's no way the examples can depend on anything in
 #'   the current session, but interactive code (like [browser()])
@@ -25,8 +22,18 @@
 #'   examples are updated before running them.
 #' @keywords programming
 #' @export
-run_examples <- function(pkg = ".", start = NULL, show = TRUE, test = FALSE,
-                         run = FALSE, fresh = FALSE, document = TRUE) {
+run_examples <- function(pkg = ".", start = NULL, show = TRUE, run_donttest = FALSE,
+                         run_dontrun = FALSE, fresh = FALSE, document = TRUE, run, test) {
+
+  if (!missing(run)) {
+    warning("`run_examples(run=)` is deprecated, please use `run_example(run_dontrun=)` instead", call. = FALSE)
+    run_dontrun <- run
+  }
+  if (!missing(test)) {
+    warning("`run_examples(test=)` is deprecated, please use `run_example(run_donttest=)` instead", call. = FALSE)
+    run_donttest <- test
+  }
+
   pkg <- as.package(pkg)
 
   if (fresh) {
@@ -60,7 +67,7 @@ run_examples <- function(pkg = ".", start = NULL, show = TRUE, test = FALSE,
   load_all(pkg$path, reset = TRUE, export_all = FALSE)
   on.exit(load_all(pkg$path, reset = TRUE))
 
-  lapply(files, pkgload::run_example, test = test, run = run)
+  lapply(files, pkgload::run_example, run_donttest = run_donttest, run_dontrun = run_dontrun)
 
   invisible()
 }