Run a pipeline of targets in parallel with transient
This function is like
tar_make() except that targets
run in parallel with transient
future workers. It requires
that you declare your
future::plan() inside the
target script file (default:
future is not a strict dependency of
so you must install
tar_make_future( names = NULL, shortcut = targets::tar_config_get("shortcut"), reporter = targets::tar_config_get("reporter_make"), workers = targets::tar_config_get("workers"), callr_function = callr::r, callr_arguments = targets::callr_args_default(callr_function, reporter), envir = parent.frame(), script = targets::tar_config_get("script"), store = targets::tar_config_get("store") )
Names of the targets to build or check. Set to
NULLto check/build all the targets (default). Otherwise, you can supply
tar_make()and friends run the pipeline in a new R session, if you pass a character vector to a tidyselect helper, you will need to evaluate that character vector early with
tar_make(names = all_of(!!your_vector)). Applies to ordinary targets (stem) and whole dynamic branching targets (patterns) but not to 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.
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. It relies on stored metadata for information about upstream dependencies.
shortcut = TRUEonly works if you set
Character of length 1, name of the reporter to user. Controls how messages are printed as targets run in the pipeline. Defaults to
"silent": print nothing.
"summary": print a running total of the number of each targets in each status category (queued, started, skipped, build, canceled, or errored). Also show a timestamp (
strptime()format) of the last time the progress changed and printed to the screen.
"timestamp": same as the
"verbose"reporter except that each .message begins with a time stamp.
"timestamp_positives": same as the
"timestamp"reporter except without messages for skipped targets.
"verbose": print messages for individual targets as they start, finish, or are skipped.
"verbose_positives": same as the
"verbose"reporter except without messages for skipped targets.
Positive integer, maximum number of transient
futureworkers allowed to run at any given time.
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.
NULL except if
callr_function = callr::r_bg(), in which case
a handle to the
callr background process is returned. Either way,
the value is invisibly returned.
tar_make_future() with a computing cluster,
future.batchtools package documentation.