tar_config_set()
writes special custom settings
for the current project to an optional YAML configuration file.
Usage
tar_config_set(
inherits = NULL,
reporter_make = NULL,
reporter_outdated = NULL,
store = NULL,
shortcut = NULL,
script = NULL,
workers = NULL,
config = Sys.getenv("TAR_CONFIG", "_targets.yaml"),
project = Sys.getenv("TAR_PROJECT", "main")
)
Arguments
- inherits
Character of length 1, name of the project from which the current project should inherit configuration settings. The current project is the
project
argument, which defaults toSys.getenv("TAR_PROJECT", "main")
. If theinherits
argumentNULL
, theinherits
setting is not modified. Usetar_config_unset()
to delete a setting.- reporter_make
Character of length 1,
reporter
argument totar_make()
and related functions that run the pipeline. If the argumentNULL
, the setting is not modified. Usetar_config_unset()
to delete a setting.- reporter_outdated
Character of length 1,
reporter
argument totar_outdated()
and related functions that do not run the pipeline. If the argumentNULL
, the setting is not modified. Usetar_config_unset()
to delete a setting.- store
Character of length 1, path to the data store of the pipeline. If
NULL
, thestore
setting is left unchanged in the YAML configuration file (default:_targets.yaml
). Usually, the data store lives at_targets
. Setstore
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. If the argumentNULL
, the setting is not modified. Usetar_config_unset()
to delete a setting.- shortcut
logical of length 1, default
shortcut
argument totar_make()
and related functions. If the argumentNULL
, the setting is not modified. Usetar_config_unset()
to delete a setting.- script
Character of length 1, path to the target script file that defines the pipeline (
_targets.R
by default). This path should be either an absolute path or a path relative to the project root where you will calltar_make()
and other functions. Whentar_make()
and friends run the script from the current working directory. If the argumentNULL
, the setting is not modified. Usetar_config_unset()
to delete a setting.- workers
Positive numeric of length 1,
workers
argument oftar_make_clustermq()
and related functions that run the pipeline with parallel computing among targets. If the argumentNULL
, the setting is not modified. Usetar_config_unset()
to delete a setting.- config
Character of length 1, file path of the YAML configuration file with
targets
project settings. Theconfig
argument specifies which YAML configuration file thattar_config_get()
reads from ortar_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 theTAR_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 astar_make()
because the default arguments to those functions are controlled bytar_config_get()
.- project
Character of length 1, name of the current
targets
project. Thanks to theconfig
R package,targets
YAML configuration files can store multiple sets of configuration settings, with each set corresponding to its own project. Theproject
argument allows you to set or get a configuration setting for a specific project for a given call totar_config_set()
ortar_config_get()
. The default project is always called"main"
unless you set another default project using theTAR_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 astar_make()
because the default arguments to those functions are controlled bytar_config_get()
.
Configuration
For several key functions like tar_make()
, the
default values of arguments are controlled though
tar_config_get()
. tar_config_get()
retrieves data
from an optional YAML configuration file.
You can control the settings in the YAML
file programmatically with tar_config_set()
.
The default file path of this YAML file is _targets.yaml
, and you can
set another path globally using the TAR_CONFIG
environment variable. The YAML file can store configuration
settings for multiple projects, and you can globally
set the default project with the TAR_PROJECT
environment
variable.
The structure of the YAML file
follows rules similar to the config
R package, e.g.
projects can inherit settings from one another using the inherits
field.
Exceptions include:
There is no requirement to have a configuration named
"default"
.Other projects do not inherit from the default project` automatically.
Not all fields need values because
targets
already has defaults.
targets
does not actually invoke
the config
package. The implementation in targets
was written from scratch without viewing or copying any
part of the source code of config
.
See also
Other configuration:
tar_config_get()
,
tar_config_unset()
,
tar_envvars()
,
tar_option_get()
,
tar_option_reset()
,
tar_option_set()
Examples
if (identical(Sys.getenv("TAR_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
})
}