tar_completed()

NAMESPACE

@@ -371,6 +371,7 @@ export(tar_callr_args_default)
 export(tar_callr_inner_try)
 export(tar_cancel)
 export(tar_canceled)
+export(tar_completed)
 export(tar_config_get)
 export(tar_config_projects)
 export(tar_config_set)

R/tar_built.R

@@ -1,8 +1,9 @@
-#' @title List built targets.
+#' @title Deprecated: list built targets.
 #' @export
-#' @family progress
-#' @description List targets whose progress is `"built"`.
-#' @return A character vector of built targets.
+#' @keywords internal
+#' @description Deprecated in favor of [tar_completed()] on 2023-12-04
+#'   (version 1.3.2.9004).
+#' @return A character vector of completed targets.
 #' @inheritParams tar_progress
 #' @param names Optional, names of the targets. If supplied, the
 #'   function restricts its output to these targets.
@@ -18,14 +19,18 @@
 #'   )
 #' }, ask = FALSE)
 #' tar_make()
-#' tar_built()
-#' tar_built(starts_with("y_")) # see also any_of()
+#' tar_completed()
+#' tar_completed(starts_with("y_")) # see also any_of()
 #' })
 #' }
 tar_built <- function(
   names = NULL,
   store = targets::tar_config_get("store")
 ) {
+  tar_warn_deprecate(
+    "tar_built() is deprecated in targets version >= 1.3.2.9004 ",
+    "(2021-12-04). Use tar_completed() instead."
+  )
   tar_assert_allow_meta("tar_built", store)
   progress <- progress_init(path_store = store)
   progress <- tibble::as_tibble(progress$database$read_condensed_data())
@@ -34,5 +39,5 @@ tar_built <- function(
   if (!is.null(names)) {
     progress <- progress[match(names, progress$name), , drop = FALSE] # nolint
   }
-  progress$name[progress$progress == "built"]
+  progress$name[progress$progress == "completed"]
 }

R/tar_completed.R

@@ -0,0 +1,38 @@
+#' @title List completed targets.
+#' @export
+#' @family progress
+#' @description List targets whose progress is `"completed"`.
+#' @return A character vector of completed targets.
+#' @inheritParams tar_progress
+#' @param names Optional, names of the targets. If supplied, the
+#'   function restricts its output to these targets.
+#'   You can supply symbols
+#'   or `tidyselect` helpers like [any_of()] and [starts_with()].
+#' @examples
+#' if (identical(Sys.getenv("TAR_EXAMPLES"), "true")) { # for CRAN
+#' tar_dir({ # tar_dir() runs code from a temp dir for CRAN.
+#' tar_script({
+#'   list(
+#'     tar_target(x, seq_len(2)),
+#'     tar_target(y, 2 * x, pattern = map(x))
+#'   )
+#' }, ask = FALSE)
+#' tar_make()
+#' tar_completed()
+#' tar_completed(starts_with("y_")) # see also any_of()
+#' })
+#' }
+tar_completed <- function(
+  names = NULL,
+  store = targets::tar_config_get("store")
+) {
+  tar_assert_allow_meta("tar_completed", store)
+  progress <- progress_init(path_store = store)
+  progress <- tibble::as_tibble(progress$database$read_condensed_data())
+  names_quosure <- rlang::enquo(names)
+  names <- tar_tidyselect_eval(names_quosure, progress$name)
+  if (!is.null(names)) {
+    progress <- progress[match(names, progress$name), , drop = FALSE] # nolint
+  }
+  progress$name[progress$progress == "completed"]
+}

R/tar_started.R

@@ -3,7 +3,7 @@
 #' @keywords internal
 #' @description Deprecated in favor of [tar_dispatched()] on 2023-12-04
 #'   (version 1.3.2.9004).
-#' @return A character vector of started targets.
+#' @return A character vector of dispatched targets.
 #' @inheritParams tar_progress
 #' @param names Optional, names of the targets. If supplied, the
 #'   function restricts its output to these targets.