R: Tools for Models Available in 'train'

modelLookup {caret}

R Documentation

Tools for Models Available in `train`

Description

These function show information about models and packages that are accessible via train

Usage

modelLookup(model = NULL)

getModelInfo(model = NULL, regex = TRUE, ...)

checkInstall(pkg)

Arguments

`model`	a character string associated with the `method` argument of `train`. If no value is passed, all models are returned. For `getModelInfo`, regular expressions can be used.
`regex`	a logical: should a regular expressions be used? If `FALSE`, a simple match is conducted against the whole name of the model.
`pkg`	a character string of package names.
`...`	options to pass to `grepl`

Details

modelLookup is good for getting information related to the tuning parameters for a model. getModelInfo will return all the functions and metadata associated with a model. Both of these functions will only search within the models bundled in this package.

checkInstall will check to see if packages are installed. If they are not and the session is interactive, an option is given to install the packages using install.packages using that functions default arguments (the missing packages are listed if you would like to install them with other options). If the session is not interactive, an error is thrown.

Value

modelLookup produces a data frame with columns

`model`	a character string for the model code
`parameter`	the tuning parameter name
`label`	a tuning parameter label (used in plots)
`forReg`	a logical; can the model be used for regression?
`forClass`	a logical; can the model be used for classification?
`probModel`	a logical; does the model produce class probabilities?

getModelInfo returns a list containing one or more lists of the standard model information.

checkInstall returns not value.

Note

The column seq is no longer included in the output of modelLookup.

Author(s)

Max Kuhn

Examples

modelLookup()
modelLookup("gbm")

getModelInfo("pls")
getModelInfo("^pls")
getModelInfo("pls", regex = FALSE)

## Not run: 
checkInstall(getModelInfo("pls")$library)

## End(Not run)

[Package caret version 6.0-35 Index]

Tools for Models Available in train