Return the vertices and edges of a pipeline dependency graph.Source:
Analyze the pipeline defined in the target script file
and return the vertices and edges of the directed acyclic graph
of dependency relationships.
tar_network( targets_only = FALSE, names = NULL, shortcut = FALSE, allow = NULL, exclude = NULL, outdated = TRUE, reporter = targets::tar_config_get("reporter_outdated"), seconds_reporter = targets::tar_config_get("seconds_reporter"), callr_function = callr::r, callr_arguments = targets::tar_callr_args_default(callr_function, reporter), envir = parent.frame(), script = targets::tar_config_get("script"), store = targets::tar_config_get("store") )
Logical, whether to restrict the output to just targets (
FALSE) or to also include imported global functions and objects.
Names of targets. The graph visualization will operate only on these targets (and unless
TRUE, all the targets upstream as well). Selecting a small subgraph using
namescould speed up the load time of the visualization. Unlike
namesis invoked before the graph is generated. Set to NULL to check/run all the targets (default). Otherwise, you can supply symbols or tidyselect helpers like starts_with(). Applies to ordinary targets (stem) and whole dynamic branching targets (patterns) but not individual dynamic branches.
Logical of length 1, how to interpret the
FALSE(default) then the function checks all targets upstream of
namesas far back as the dependency graph goes. If
TRUE, then the function only checks the targets in
namesand uses stored metadata for information about upstream dependencies as needed.
shortcut = TRUEincreases speed if there are a lot of up-to-date targets, but it assumes all the dependencies are up to date, so please use with caution. Also,
shortcut = TRUEonly works if you set
Optional, define the set of allowable vertices in the graph. Unlike
allowis invoked only after the graph is mostly resolved, so it will not speed up execution. Set to
NULLto allow all vertices in the pipeline and environment (default). Otherwise, you can supply symbols or
Optional, define the set of exclude vertices from the graph. Unlike
excludeis invoked only after the graph is mostly resolved, so it will not speed up execution. Set to
NULLto exclude no vertices. Otherwise, you can supply symbols or
Logical, whether to show colors to distinguish outdated targets from up-to-date targets. (Global functions and objects still show these colors.) Looking for outdated targets takes a lot of time for large pipelines with lots of branches, and setting
FALSEis a nice way to speed up the graph if you only want to see dependency relationships and pipeline progress.
Character of length 1, name of the reporter to user. Controls how messages are printed as targets are checked. Choices:
"silent": print nothing.
"forecast": print running totals of the checked and outdated targets found so far.
Positive numeric of length 1 with the minimum number of seconds between times when the reporter prints progress messages to the R console.
A function from
callrto start a fresh clean R process to do the work. Set to
NULLto 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_functionneeds to be
NULLfor interactive debugging, e.g.
tar_option_set(debug = "your_target"). However,
callr_functionshould not be
NULLfor serious reproducible work.
A list of arguments to
An environment, where to run the target R script (default:
NULL. Ignored if
callr_functionis anything other than
callr_functionshould only be
NULLfor debugging and testing purposes, not for serious runs of a pipeline, etc.
tar_make()and related functions always overrides the current value of
tar_option_get("envir")in the current R session just before running the target script file, so whenever you need to set an alternative
envir, you should always set it with
tar_option_set()from within the target script file. In other words, if you call
tar_option_set(envir = envir1)in an interactive session and then
tar_make(envir = envir2, callr_function = NULL), then
envir2will be used.
Character of length 1, path to the target script file. Defaults to
tar_config_get("script"), which in turn defaults to
_targets.R. When you set this argument, the value of
tar_config_get("script")is temporarily changed for the current function call. See
tar_config_set()for details about the target script file and how to set it persistently for a project.
Character of length 1, path to the
targetsdata 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_set()for details about how to set the data store path persistently for a project.
A list with two data frames:
vertices data frame has one row per target with fields to denote
the type of the target or object (stem, branch, map, cross, function,
or object) and the target's status
(up to date, outdated, dispatched, completed, canceled, or errored).
The edges data frame has one row for every edge and columns
from to mark the starting and terminating vertices.
The dependency graph of a pipeline is a directed acyclic graph (DAG)
where each node indicates a target or global object and each directed
edge indicates where a downstream node depends on an upstream node.
The DAG is not always a tree, but it never contains a cycle because
no target is allowed to directly or indirectly depend on itself.
The dependency graph should show a natural progression of work from
left to right.
targets uses static code analysis to create the graph,
so the order of
tar_target() calls in the
does not matter. However, targets does not support self-referential
loops or other cycles. For more information on the dependency graph,