run_one_experiment: Run one in-set/out-set error estimation experiment

In mrfoliveira/STEvaluation-MDPI2021: Evaluation procedures for forecasting with spatio-temporal data

Description

Run one in-set/out-set error estimation experiment

Usage

run_one_experiment(
  data,
  in_set_perc,
  form,
  in_estimators,
  in_est.pars,
  out_estimator = "t_oos",
  out_est.pars = list(tr.perc = in_set_perc),
  workflow = "simple_workflow",
  wf.pars = NULL,
  evaluator = "evaluate",
  eval.pars = NULL,
  seed = 1234,
  site_id = "site",
  time = "time",
  .estParallel = TRUE,
  .estVerbose = ifelse(.estParallel, FALSE, TRUE)
)

Arguments

data	a data frame
in_set_perc	a fraction of the data to be used as in-set
form	a learning formula
in_estimators	a vector of names of estimator functions to use on the in-set data
in_est.pars	a named list of the same length as in_estimators containing lists of arguments to feed to each estimator apllied to the in-set data
out_estimator	the name of the estimator function to use on the out-set data
out_est.pars	a list containing arguments to feed to the estimator apllied to the out-set data
workflow	the name of the function implementing a workflow
wf.pars	a list of arguments to feed to workflow
evaluator	the name of the function to calculate evaluation metrics
eval.pars	a list of arguments to feed to evaluator
seed	a seed to set at the start of the experiment
site_id	the name of the data column containing location identifiers
time	the name of the data column containing time-stamps
.estParallel	should each internal estimator be run in parallel
.estVerbose	write the name of the internal estimator being tested

Value

A list with two slots: out_estRes containing the results of the out-set estimators, and in_estRes containing a list of results of each estimator used on in-set data

mrfoliveira/STEvaluation-MDPI2021 documentation built on Dec. 21, 2021, 10:07 p.m.