targets (version 0.4.1)

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")

Arguments

names

Optional, names of the targets. If supplied, tar_progress() only returns progress information on these targets. You can supply symbols, a character vector, or tidyselect helpers like starts_with().

fields

Optional, names of progress data columns to read. Set to NULL to read all fields.

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", "canceled", or "errored".

See Also

Other progress: tar_poll(), tar_progress_branches(), tar_progress_summary(), tar_watch_server(), tar_watch_ui(), tar_watch()

Examples

# NOT RUN {
if (identical(Sys.getenv("TAR_LONG_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_"))
})
}
# }