add tar_option_unset()

Author: wlandau

DESCRIPTION

@@ -12,7 +12,7 @@ Description: Pipeline tools coordinate the pieces of computationally
   The methodology in this package
   borrows from GNU 'Make' (2015, ISBN:978-9881443519)
   and 'drake' (2018, <doi:10.21105/joss.00550>).
-Version: 1.11.4.9002
+Version: 1.11.4.9003
 License: MIT + file LICENSE
 URL: https://docs.ropensci.org/targets/, https://github.com/ropensci/targets
 BugReports: https://github.com/ropensci/targets/issues

NAMESPACE

@@ -470,6 +470,7 @@ export(tar_option_export)
 export(tar_option_get)
 export(tar_option_reset)
 export(tar_option_set)
+export(tar_option_unset)
 export(tar_option_with)
 export(tar_outdated)
 export(tar_path)

NEWS.md

@@ -1,7 +1,8 @@
-# targets 1.11.4.9002 (development)
+# targets 1.11.4.9003 (development)
 
 * Avoid loading non-targets in `tar_load(everything())` (#1529, @pitakakariki).
 * For internal consistency, return `NA_character_` from `tar_path_target()` when `format` is `"file"` (#1532, @noamross).
+* Add `tar_option_unset()` (#1521, @noamross).
 
 # targets 1.11.4
 

R/tar_option_unset.R

@@ -0,0 +1,37 @@
+#' @title Unset one or more target options.
+#' @export
+#' @family configuration
+#' @description Unset one or more target options you previously chose with
+#'   [tar_option_set()]. These options are mostly configurable default
+#'   arguments to [tar_target()] and [tar_target_raw()].
+#' @return `NULL` (invisibly).
+#' @param options A character vector of options to reset. Must all be elements of
+#'   `names(formals(tar_option_set))`
+#' @examples
+#' tar_option_get("format") # default format before we set anything
+#' tar_target(x, 1)$settings$format
+#' tar_option_set(format = "fst_tbl") # new default format
+#' tar_option_get("format")
+#' tar_target(x, 1)$settings$format
+#' tar_option_unset("format") # Unsets the format option.
+#' tar_target(x, 1)$settings$format
+#' if (identical(Sys.getenv("TAR_EXAMPLES"), "true")) { # for CRAN
+#' tar_dir({ # tar_dir() runs code from a temp dir for CRAN.
+#' tar_script({
+#'   library(targets)
+#'   library(tarchetypes)
+#'   tar_option_set(cue = tar_cue(mode = "always"))
+#'   tar_option_unset("cue") # Unsets the cue option.
+#'   list(tar_target(x, 1), tar_target(y, 2))
+#' })
+#' tar_make()
+#' tar_make()
+#' })
+#' }
+tar_option_unset <- function(options) {
+  tar_assert_in(x = options, choices = names(formals(tar_option_set)))
+  for (option in options) {
+    tar_options[[option]] <- NULL
+  }
+  invisible()
+}

_pkgdown.yml

@@ -38,6 +38,7 @@ reference:
   - 'tar_option_get'
   - 'tar_option_reset'
   - 'tar_option_set'
+  - 'tar_option_unset'
   - 'tar_option_with'
 - title: Targets
   contents: