modelinfo: Display Model Information

View source: R/modelinfo.R

modelinfoR Documentation

Display Model Information

Description

Display information about models supplied by the MachineShop package.

Usage

modelinfo(...)

Arguments

...

model functions, function names, or objects; observed responses for which to display information. If none are specified, information is returned on all available models by default.

Value

List of named model elements each containing the following components:

label

character descriptor for the model.

packages

character vector of source packages required to use the model. These need only be installed with the install.packages function or by equivalent means; but need not be loaded with, for example, the library function.

response_types

character vector of response variable types supported by the model.

weights

logical value or vector of the same length as response_types indicating whether case weights are supported for the responses.

arguments

closure with the argument names and corresponding default values of the model function.

grid

logical indicating whether automatic generation of tuning parameter grids is implemented for the model.

varimp

logical indicating whether model-specific variable importance is defined.

Examples

## All models
modelinfo()

## Models by response types
names(modelinfo(factor(0)))
names(modelinfo(factor(0), numeric(0)))

## Model-specific information
modelinfo(GBMModel)


MachineShop documentation built on Sept. 5, 2022, 5:08 p.m.