Skip to contents

Run a multi-phase workflow project

Source: R/RunProject.R
RunProject.Rd

[Experimental]

RunProject() runs multiple workflow phase folders in sequence, sharing one lData object across phases. Each subdirectory of strPath is treated as a phase. Phases are executed in sorted order (or in the order specified by strPhases). Within each phase, workflows are loaded via MakeWorkflowList() and run via RunWorkflows().

Usage

RunProject(
  strPath,
  lData = NULL,
  lConfig = NULL,
  strPhases = NULL,
  bRecursive = FALSE,
  bReturnResult = TRUE,
  bKeepInputData = FALSE,
  strResultNames = c("Type", "ID")
)

Arguments

strPath

character Path to the project directory. Must contain one or more subdirectories, each holding workflow YAML files.

lData

list Initial named list of data objects. Default NULL.

lConfig

list Configuration hooks passed to RunWorkflows(). Default NULL.

strPhases

character Optional vector of phase folder names to run. If NULL (the default), all sorted subdirectories of strPath are used.

bRecursive

logical Passed to MakeWorkflowList(). Default FALSE.

bReturnResult

logical Passed to RunWorkflows(). Default TRUE.

bKeepInputData

logical Passed to RunWorkflows(). Default FALSE.

strResultNames

character Vector of length two passed to RunWorkflows(). Default c("Type", "ID").

Value

A named list with one element per phase. Each element contains the result returned by RunWorkflows() for that phase.

Examples

if (FALSE) { # \dontrun{
results <- RunProject("inst/workflows")
} # }