model_by_version: Model the data for a given version configuration

In BigelowLab/calanusthreshold: calanusthreshold

Model the data for a given version configuration

Description

Model the data for a given version configuration

Usage

model_by_version(
  cfg = read_config(system.file("exdata/cf.std.000.yaml", package =
    "calanusthreshold")),
  x = read_dataset(),
  save_model = FALSE,
  save_pred = FALSE,
  save_summary = FALSE,
  path = ".",
  verbose = interactive()
)

Arguments

cfg	list, as per read_config
x	input data set (as data.frame or tibble). See read_dataset
save_model	logical, if TRUE save the model, see path
save_pred	logical, if TRUE save the prediction (made with testing data split), see path
save_summary	logical, if TRUE save the summary (made with testing data split), see path
path	character, output path, if it doesn't exists the it is created. Subdirectories are created for saving model, prediction, and summary
verbose	logical, if TRUE output helpful messages

Value

model_fit object or NULL This gets returned when there is an issue

BigelowLab/calanusthreshold documentation built on May 12, 2022, 5:06 a.m.