targets (version 0.4.1)

tar_config_set: Write configuration settings to _targets.yaml.

Description

tar_config_set() writes special custom settings to an optional _targets.yaml configuration file at the current project. Do not invoke while the pipeline is running.

Usage

tar_config_set(store = NULL)

Arguments

store

Character of length 1, path to the data store of the pipeline. If NULL, the store setting is left unchanged in _targets.yaml. Usually, the data store lives at _targets. Set store to a custom directory to specify a path other than _targets. The path need not exist before the pipeline begins, and it need not end with "_targets", but it must be writeable. For optimal performance, choose a storage location with fast read/write access.

Value

NULL (invisibly)

Details

_targets.yaml is an optional YAML configuration file with settings specific to a given project. You can write it by hand or modify it with tar_config_set(). In order to work properly, _targets.yaml must live at the root of the project (next to _targets.R). The currently supported configuration settings are documented as the arguments of tar_config_set().

tar_config_set() always writes a _targets.yaml file with a full set of configuration settings even when no arguments are supplied. To reset options completely, simply remove _targets.yaml.

See Also

Other configuration: tar_config_get(), tar_envvars(), tar_option_get(), tar_option_reset(), tar_option_set()

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, 1 + 1)))
tar_config_get("store") # NULL (data store defaults to "_targets/")
store_path <- tempfile()
tar_config_set(store = store_path)
tar_config_get("store") # Shows a temp file.
tar_make() # Writes to the custom data store identified in _targets.yaml.
tar_read(x) # tar_read() knows about _targets.yaml too.
file.exists("_targets") # FALSE
file.exists(store_path) # TRUE
})
}
# }