Run the steps in the data prep, analysis and visualisation workflow pipeline

This function runs each step in the data preparation, data analysis and visualisation pipeline. Note that it will generally take an appreciable amount of time to run.

Usage

run_workflow(
  steps_to_run = NULL,
  cfg = NULL,
  cfg_overrides = NULL,
  cfg_dir = NULL,
  cfg_name = NULL,
  banner_only = NULL
)

Arguments

steps_to_run

A character string specifying comma-separated identifiers for steps to run in the workflow.
These can be:
1a, 1b, 1c, 1d, 1e, 1f, 2, 3a, 3b, 4a, 4b, 5a, 5b
Default: "1a, 1b, 1c, 1d, 1e, 1f, 2, 3a, 3b, 4a, 4b, 5a, 5b" (run all steps)

cfg

A list of nested lists, with 'leaf' nodes specifying configuration values. Default: The template config returned by generate_cfg_template()

cfg_overrides

An optional list containing settings with which to override the config values for this run.

cfg_dir

A character string specifying the config directory, or NULL for the default. Default: An OS-specific path for user configuration files in the user's home directory.

cfg_name

A character string specifying the config file name, or NULL for the default. Default: 'config.yml'

banner_only

A boolean indicating whether to only show banners for each step which would be run, or to run the function as well (useful for checking which steps would be run).

Value

NULL (invisibly).

Examples

run_workflow("1a", banner_only = TRUE)
#> Warning: cannot open file '/home/runner/.config/R-dimex/config.yml': No such file or directory
#> Error in file(file, "rt", encoding = fileEncoding): cannot open the connection
if (FALSE) { # \dontrun{
run_workflow("1a")
run_workflow("1a,1b,1c,1d,1e,1f,2,3a,3b,4a,4b,5a,5b", banner_only = TRUE)
run_workflow(banner_only = TRUE)
run_workflow("4a, 4b")
run_workflow("4a, 4b", banner_only = TRUE)
run_workflow("1a, 1b, 1c, 1d, 1e, 1f, 2, 3a, 3b, 4a, 4b")
run_workflow()
} # }