targets: tar_progress – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

tar_progress

Read progress.

Description

Read a project's target progress data for the most recent run of tar_make() or similar. Only the most recent record is shown.

Usage

tar_progress(
  names = NULL,
  fields = "progress",
  store = targets::tar_config_get("store")
)

Arguments

`names`	Optional, names of the targets. If supplied, `tar_progress()` only returns progress information on these targets. You can supply symbols or `tidyselect` helpers like `all_of()` and `starts_with()`.
`fields`	Optional, names of progress data columns to read. Set to `NULL` to read all fields.
`store`	Character of length 1, path to the `targets` data store. Defaults to `tar_config_get("store")`, which in turn defaults to `_targets/`. When you set this argument, the value of `tar_config_get("store")` is temporarily changed for the current function call. See `tar_config_get()` and `tar_config_set()` for details about how to set the data store path persistently for a project.

Value

A data frame with one row per target and the following columns:

name: name of the target.
type: type of target: "stem" for non-branching targets, "pattern" for dynamically branching targets, and "branch" for dynamic branches.
parent: name of the target's parent. For branches, this is the name of the associated pattern. For other targets, the pattern is just itself.
branches: number of dynamic branches of a pattern. 0 for non-patterns.
progress: the most recent progress update of that target. Could be "started", "built", "skipped", "canceled", or "errored".

Examples

if (identical(Sys.getenv("TAR_EXAMPLES"), "true")) {
tar_dir({ # tar_dir() runs code from a temporary directory.
tar_script({
  list(
    tar_target(x, seq_len(2)),
    tar_target(y, 2 * x, pattern = map(x))
  )
}, ask = FALSE)
tar_make()
tar_progress()
tar_progress(starts_with("y_")) # see also all_of()
})
}

targets

Dynamic Function-Oriented 'Make'-Like Declarative Workflows

v0.10.0

MIT + file LICENSE

Authors

William Michael Landau [aut, cre] (<https://orcid.org/0000-0003-1878-3253>), Matthew T. Warkentin [ctb], Samantha Oliver [rev] (<https://orcid.org/0000-0001-5668-1165>), Tristan Mahr [rev] (<https://orcid.org/0000-0002-8890-5116>), Eli Lilly and Company [cph]

Initial release