MachineShop (version 2.0.0)

SelectedModelFrame: Selected Model Frame

Description

Formula, design matrix, or model frame selection from a candidate set.

Usage

SelectedFormula(
  ...,
  data,
  control = MachineShop::settings("control"),
  metrics = NULL,
  stat = MachineShop::settings("stat.Train"),
  cutoff = MachineShop::settings("cutoff")
)
SelectedMatrix(
  ...,
  y,
  control = MachineShop::settings("control"),
  metrics = NULL,
  stat = MachineShop::settings("stat.Train"),
  cutoff = MachineShop::settings("cutoff")
)
SelectedModelFrame(
  ...,
  control = MachineShop::settings("control"),
  metrics = NULL,
  stat = MachineShop::settings("stat.Train"),
  cutoff = MachineShop::settings("cutoff")
)

Arguments

...

formula, design matrix of predictors, or ModelFrame objects, or a list of one of these types.

data

data frame or an object that can be converted to one.

control

control function, function name, or call defining the resampling method to be employed.

metrics

metric function, function name, or vector of these with which to calculate performance. If not specified, default metrics defined in the performance functions are used. Recipe selection is based on the first calculated metric.

stat

function or character string naming a function to compute a summary statistic on resampled metric values for recipe selection.

cutoff

argument passed to the metrics functions.

y

response variable.

Value

SelectedModelFrame class object that inherits from ModelFrame.

See Also

fit, resample

Examples

# NOT RUN {
sel_fo <- SelectedFormula(
  sale_amount ~ sale_year + built + style + construction,
  sale_amount ~ sale_year + base_size + bedrooms + basement,
  data = ICHomes
)

model_fit <- fit(sel_fo, model = GLMModel)
(selected_model <- as.MLModel(model_fit))
plot(selected_model)

# }