Skip to contents

Run a workflow via it's YAML specification.

Source: R/RunWorkflow.R
RunWorkflow.Rd

[Stable]

Attempts to run a single assessment (lWorkflow) using shared data (lData) and metadata (lMapping). Calls RunStep for each item in lWorkflow$workflow and saves the results to lWorkflow.

Usage

RunWorkflow(
  lWorkflow,
  lData = NULL,
  lConfig = NULL,
  bReturnResult = TRUE,
  bKeepInputData = TRUE
)

Arguments

lWorkflow

list A named list of metadata defining how the workflow should be run.

lData

list A named list of domain-level data frames.

lConfig

list Optional configuration object. Supported hook fields:

  • LoadData: Optional function or registered provider name used before spec validation. Functions must accept lWorkflow, lConfig, and lData as named formals. workr includes a built-in "gsm.datasim" provider that reads adapter settings from lConfig$gsm.datasim.

  • SaveData: Optional function or registered provider name used before returning results when bReturnResult = TRUE. Functions must accept lWorkflow and lConfig as named formals.

bReturnResult

boolean should only the result from the last step (lResults) be returned? If false, the full workflow (including lResults) is returned. Default is TRUE.

bKeepInputData

boolean should the input data be included in lData after the workflow is run? Only relevant when bReturnResult is FALSE. Default is TRUE.

Value

Object containing the results of the workflow's last step (if bLastResult is TRUE) or the full workflow object (if bReturnResults is TRUE) or the full workflow object (if bReturnResults is FALSE).

Examples

if (FALSE) { # \dontrun{
# Load a simple workflow from YAML
wf <- yaml::read_yaml(
  system.file("example_workflows", "cars.yaml", package = "workr")
)
lData <- list(cars = cars)

# Run the workflow
result <- RunWorkflow(wf, lData)
summary(result)
} # }