Last chance! 50% off unlimited learning
Sale ends in
Launches a background process with a Shiny app
that calls tar_visnetwork() every few seconds.
To embed this app in other apps, use the Shiny module
in tar_watch_ui() and tar_watch_server().
tar_watch(
seconds = 10,
seconds_min = 1,
seconds_max = 60,
seconds_step = 1,
targets_only = FALSE,
exclude = ".Random.seed",
outdated = FALSE,
label = NULL,
level_separation = 150,
degree_from = 1L,
degree_to = 1L,
config = Sys.getenv("TAR_CONFIG", "_targets.yaml"),
project = Sys.getenv("TAR_PROJECT", "main"),
height = "650px",
display = "summary",
displays = c("summary", "branches", "progress", "graph", "about"),
background = TRUE,
browse = TRUE,
host = getOption("shiny.host", "127.0.0.1"),
port = getOption("shiny.port", targets::tar_random_port()),
verbose = TRUE,
supervise = TRUE,
poll_connection = TRUE,
stdout = "|",
stderr = "|",
title = "",
theme = bslib::bs_theme(),
spinner = TRUE
)A handle to callr::r_bg() background process running the app.
Numeric of length 1, default number of seconds between refreshes of the graph. Can be changed in the app controls.
Numeric of length 1, lower bound of seconds
in the app controls.
Numeric of length 1, upper bound of seconds
in the app controls.
Numeric of length 1, step size of seconds
in the app controls.
Logical, whether to restrict the output to just targets
(FALSE) or to also include global functions and objects.
Character vector of nodes to omit from the graph.
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 outdated to FALSE is a nice way to speed up the graph
if you only want to see dependency relationships and pipeline progress.
Label argument to tar_visnetwork().
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 a value chosen by targets.
Integer of length 1. When you click on a node,
the graph highlights a neighborhood of that node. degree_from
controls the number of edges the neighborhood extends upstream.
Integer of length 1. When you click on a node,
the graph highlights a neighborhood of that node. degree_to
controls the number of edges the neighborhood extends downstream.
Character of length 1, file path of the YAML
configuration file with targets project settings.
The config argument specifies which YAML configuration
file that tar_config_get() reads from or tar_config_set()
writes to in a single function call.
It does not globally change which configuration file is used
in subsequent function calls. The default file path of the YAML
file is always _targets.yaml unless you set another
default path using the TAR_CONFIG environment variable,
e.g. Sys.setenv(TAR_CONFIG = "custom.yaml"). This also has the
effect of temporarily modifying the default arguments to other functions
such as tar_make() because the default arguments
to those functions are controlled by tar_config_get().
Character of length 1, name of the current
targets project. Thanks to the config R package,
targets YAML configuration files can store multiple
sets of configuration settings, with each set corresponding
to its own project. The project argument allows you to
set or get a configuration setting for a specific project
for a given call to tar_config_set() or tar_config_get().
The default project is always called "main"
unless you set another
default project using the TAR_PROJECT environment variable,
e.g. Sys.setenv(tar_project = "custom"). This also has the
effect of temporarily modifying the default arguments to other functions
such as tar_make() because the default arguments
to those functions are controlled by tar_config_get().
Character of length 1,
height of the visNetwork widget and branches table.
Character of length 1, which display to show first.
Character vector of choices for the display.
Elements can be any of
"graph", "summary", "branches", or "about".
Logical, whether to run the app in a background process so you can still use the R console while the app is running.
Whether to open the app in a browser when the app is ready.
Only relevant if background is TRUE.
Character of length 1, IPv4 address to listen on.
Only relevant if background is TRUE.
Positive integer of length 1, TCP port to listen on.
Only relevant if background is TRUE.
whether to print a spinner and informative messages.
Only relevant if background is TRUE.
Whether to register the process with a supervisor. If TRUE,
the supervisor will ensure that the process is killed when the R process
exits.
Whether to have a control connection to the process. This is used to transmit messages from the subprocess to the main process.
The name of the file the standard output of
the child R process will be written to.
If the child process runs with the --slave option (the default),
then the commands are not echoed and will not be shown
in the standard output. Also note that you need to call print()
explicitly to show the output of the command(s).
IF NULL (the default), then standard output is not returned, but
it is recorded and included in the error object if an error happens.
The name of the file the standard error of
the child R process will be written to.
In particular message() sends output to the standard
error. If nothing was sent to the standard error, then this file
will be empty. This argument can be the same file as stdout,
in which case they will be correctly interleaved. If this is the
string "2>&1", then standard error is redirected to standard output.
IF NULL (the default), then standard output is not returned, but
it is recorded and included in the error object if an error happens.
Character of length 1, title of the UI.
A call to bslib::bs_theme() with the bslib theme.
TRUE to add a busy spinner, FALSE to omit.
The controls of the app are in the left panel.
The seconds control is the number of seconds between
refreshes of the graph, and the other settings match
the arguments of tar_visnetwork().
Other progress:
tar_canceled(),
tar_completed(),
tar_dispatched(),
tar_errored(),
tar_poll(),
tar_progress(),
tar_progress_branches(),
tar_progress_summary(),
tar_skipped(),
tar_watch_server(),
tar_watch_ui()
if (identical(Sys.getenv("TAR_INTERACTIVE_EXAMPLES"), "true")) {
tar_dir({ # tar_dir() runs code from a temp dir for CRAN.
tar_script({
library(targets)
library(tarchetypes)
sleep_run <- function(...) {
Sys.sleep(10)
}
list(
tar_target(settings, sleep_run()),
tar_target(data1, sleep_run(settings)),
tar_target(data2, sleep_run(settings))
)
}, ask = FALSE)
# Launch the app in a background process.
tar_watch(seconds = 10, outdated = FALSE, targets_only = TRUE)
# Run the pipeline.
tar_make()
})
}
Run the code above in your browser using DataLab