run_gamlss_pipeline: Run GAMLSS pipeline

In MiguelRodo/gamlsspipeline:

Description

Takes arguments that specify the running of the key steps in running a GAMLSS pipeline:

• project directory creation,

• data pre-processing,

• creating exploratory plots,

• fitting the model,

• creating validation plots, and

• creating results plots.

The purpose of this is to make it easier to do all the steps in a reproducible way that saves the results automatically.

Usage

run_gamlss_pipeline(
  dir_proj,
  dir_proj_empty = FALSE,
  data_raw,
  preprocess_fn = NULL,
  plot_exp_fn = NULL,
  fit_fn = NULL,
  get_fit_stats_fn = NULL,
  plot_fit_fn = NULL,
  plot_val_fn = NULL,
  debug_live = FALSE,
  ...
)

Arguments

dir_proj	character or function. If character, then this folder is created if it doesn't exist. If a function, then it should be a function that has a single argument that expects the named list produced by rlang::list2(...). This function should simply return. the project directory as a character. This folder is created if it doesn't exist.
dir_proj_empty	logical. If TRUE, then the project directory is emptied before any results are saved. Default is FALSE. TODO: Wrap each of the *_fn functions so that whatever they return is saved to the correct folder.

MiguelRodo/gamlsspipeline documentation built on July 25, 2020, 7:23 p.m.