targets: tar_watch_server – R documentation

Pricing

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

Get Started for Free

Documentation

targets

tar_watch_server

Shiny module server for tar_watch()

Description

Use tar_watch_ui() and tar_watch_server() to include tar_watch() as a Shiny module in an app.

Usage

tar_watch_server(
  id,
  height = "650px",
  exclude = ".Random.seed",
  config = Sys.getenv("TAR_CONFIG", "_targets.yaml"),
  project = Sys.getenv("TAR_PROJECT", "main")
)

Arguments

`id`	Character of length 1, ID corresponding to the UI function of the module.
`height`	Character of length 1, height of the `visNetwork` widget and branches table.
`exclude`	Character vector of nodes to omit from the graph.
`config`	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()`.
`project`	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()`.

Value

A Shiny module server.