targets (version 0.4.1)

tar_glimpse: Visualize an abridged fast dependency graph.

Description

Analyze the pipeline defined in _targets.R and visualize the directed acyclic graph of targets. Unlike tar_visnetwork(), tar_glimpse() does not account for metadata or progress information, which means the graph renders faster. Also, tar_glimpse() omits functions and other global objects by default (but you can include them with targets_only = FALSE).

Usage

tar_glimpse(
  targets_only = TRUE,
  allow = NULL,
  exclude = ".Random.seed",
  level_separation = NULL,
  callr_function = callr::r,
  callr_arguments = targets::callr_args_default(callr_function)
)

Arguments

targets_only

Logical, whether to restrict the output to just targets (FALSE) or to also include imported global functions and objects.

allow

Optional, define the set of allowable vertices in the graph. Set to NULL to allow all vertices in the pipeline and environment (default). Otherwise, you can supply symbols, a character vector, or tidyselect helpers like starts_with().

exclude

Optional, define the set of exclude vertices from the graph. Set to NULL to exclude no vertices. Otherwise, you can supply symbols, a character vector, or tidyselect helpers like starts_with().

level_separation

Numeric of length 1, levelSeparation argument of visNetwork::visHierarchicalLayout(). Controls the distance between hierarchical levels. Consider changing the value if the aspect ratio of the graph is far from 1. If level_separation is NULL, the levelSeparation argument of visHierarchicalLayout() defaults to 150.

callr_function

A function from callr to start a fresh clean R process to do the work. Set to NULL to run in the current session instead of an external process (but restart your R session just before you do in order to clear debris out of the global environment). callr_function needs to be NULL for interactive debugging, e.g. tar_option_set(debug = "your_target"). However, callr_function should not be NULL for serious reproducible work.

callr_arguments

A list of arguments to callr_function.

Value

A visNetwork HTML widget object.

See Also

Other inspect: tar_deps_raw(), tar_deps(), tar_manifest(), tar_network(), tar_outdated(), tar_sitrep(), tar_validate(), tar_visnetwork()

Examples

# NOT RUN {
if (identical(Sys.getenv("TAR_INTERACTIVE_EXAMPLES"), "true")) {
tar_dir({ # tar_dir() runs code from a temporary directory.
tar_script({
  tar_option_set()
  list(
    tar_target(y1, 1 + 1),
    tar_target(y2, 1 + 1),
    tar_target(z, y1 + y2)
  )
}, ask = FALSE)
tar_glimpse()
tar_glimpse(allow = starts_with("y"))
})
}
# }