Execute: Execute a Workflow

Description Usage Arguments

View source: R/execution.R

Description

executes a workflow

Usage

1
2
3
Execute(workflow, moduleArgs = NULL, argsContainer = NULL,
  mode = SERIAL_MODE, clearCache = TRUE, moduleInputsSaveDir = NULL,
  getModuleExecutionInfo = FALSE)

Arguments

workflow

implementation instance of WorkflowInterface

moduleArgs

a list of lists where the name of each element corresponds to a module name in workflow and the elements are argument lists to be used for arguments not fulfilled by workflow connections to execute a module. Note, values passed with an actual connection in the workflow will override anything specified in this list.

argsContainer

a list or environment of named values to use whenever the name of a value in the container interects with an input argument of a module in workflow. Note, values passed with an actual connection in workflow or specified by moduleArgs override anything specified by this container.

mode

Defines execution mode, e.x. running modules in parallel. All defined modes are in the constants of this package.

clearCache

boolean flag that indicated if will clear out workflow module output caches.

moduleInputsSaveDir

Name of directory to save module inputs to. Inputs are saved in .rds format in form of 'module_name' + '_inputs.rds'. If NULL , the default, inputs are not saved. Please note, this feature is intended for debugging purposes – will slow execution down and take up disk space.

getModuleExecutionInfo

A logical flag TRUE/FALSE that indicated whether the list indicating module execution information should be returned after complete execution.


UptakeOpenSource/updraft documentation built on Oct. 17, 2019, 3:31 p.m.