modelLookup {caret} | R Documentation |
train
These function show information about models and packages that are accessible via train
modelLookup(model = NULL) getModelInfo(model = NULL, regex = TRUE, ...) checkInstall(pkg)
model |
a character string associated with the |
regex |
a logical: should a regular expressions be used? If |
pkg |
a character string of package names. |
... |
options to pass to |
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.
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.
The column seq
is no longer included in the output of modelLookup
.
Max Kuhn
train
, install.packages
, grepl
modelLookup() modelLookup("gbm") getModelInfo("pls") getModelInfo("^pls") getModelInfo("pls", regex = FALSE) ## Not run: checkInstall(getModelInfo("pls")$library) ## End(Not run)