run: Main function

In cottinlola/modeleVariablesAP: Apply models to all variables

Main function

Description

Main function

Usage

run(
  data = NULL,
  n_min_years = 5,
  normalize = TRUE,
  reduce_mil = FALSE,
  outliers_custom_cutoff = NULL,
  split_pct_train = 0.9,
  data_train = NULL,
  data_test = NULL,
  x_names = NULL,
  x_exclude = NULL,
  x_exclude_non_num = FALSE,
  effects = "(MILEX | IDNUM)",
  y_name,
  metric = "rmse",
  est_below_cutoff = 10,
  err_above_cutoff = 80,
  traces = FALSE
)

Arguments

data	A data.frame: the full dataset
n_min_years	An integer giving the minimal number of years a farm should appeared in the data to be selected
normalize	A logical indicating if numerical variables should be normalized
reduce_mil	A logical indicating if thousands conversion should be done
outliers_custom_cutoff	Threshold to identified outliers
split_pct_train	Ratio between train and test data
data_train	A data.frame: the training dataset
data_test	A data.frame: the testing dataset
x_names	A character vector: explainatory variables
x_exclude	A character vector: explainatory variables to exclude
x_exclude_non_num	A logicial indicating if non numeric columns should be ignored
effects	A character of random effects to consider
y_name	A character: the variable to explain
metric	A character: the metric to use for error computation
est_below_cutoff	"Acceptable" error in percent
err_above_cutoff	Desired percent of "acceptable" estimated values
traces	A logical indicating if logs should be printed

Value

A list of models, their performances and theirs variables

cottinlola/modeleVariablesAP documentation built on April 30, 2022, 7:42 a.m.