Nothing
#' Tools for Models Available in `train`
#'
#' These function show information about models and packages that are
#' accessible via [train()]
#'
#' `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 [utils::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.
#'
#' @aliases modelLookup getModelInfo checkInstall
#' @param 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.
#' @param regex a logical: should a regular expressions be used? If `FALSE`, a
#' simple match is conducted against the whole name of the model.
#' @param pkg a character string of package names.
#' @param ... options to pass to [base::grepl()]
#' @return `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 Max Kuhn
#' @seealso [train()], [utils::install.packages()], [base::grepl()]
#' @keywords utilities
#' @examplesIf !caret:::is_cran_check()
#'
#' \dontrun{
#' if (caret:::has_packages("pls")) {
#' modelLookup()
#' modelLookup("gbm")
#'
#' getModelInfo("pls")
#' getModelInfo("^pls")
#' getModelInfo("pls", regex = FALSE)
#'
#' checkInstall(getModelInfo("pls")$library)
#' }
#' }
#'
#' @export modelLookup
modelLookup <- function(model = NULL) {
load(system.file("models", "models.RData", package = "caret"))
if (!is.null(model)) {
if (!(model %in% names(models))) {
stop(paste(
"Model '",
model,
"' is not in the ",
"set of existing models",
sep = ""
))
}
models <- models[model == names(models)]
}
out <- lapply(models, function(x) {
out <- x$parameters[, c("parameter", "label")]
out$forReg <- "Regression" %in% x$type
out$forClass <- "Classification" %in% x$type
out$probModel <- !is.null(x$prob)
out
})
for (i in seq(along.with = out)) {
out[[i]]$model <- names(models)[i]
}
out <- do.call("rbind", out)
rownames(out) <- NULL
out <- out[, c(
'model',
'parameter',
'label',
'forReg',
'forClass',
'probModel'
)]
out[order(out$model), ]
}
missing_packages <- function(mods = getModelInfo()) {
libs <- unique(unlist(lapply(mods, function(x) x$library)))
here <- rownames(installed.packages())
libs[!(libs %in% here)]
}
#' @rdname modelLookup
#' @export
checkInstall <- function(pkg) {
good <- rep(TRUE, length(pkg))
for (i in seq(along.with = pkg)) {
tested <- try(find.package(pkg[i]), silent = TRUE)
if (inherits(tested, "try-error")) {
good[i] <- FALSE
}
}
if (any(!good)) {
pkList <- paste(pkg[!good], collapse = ", ")
msg <- paste(
sum(!good),
ifelse(sum(!good) > 1, " packages are", " package is"),
" needed and",
ifelse(sum(!good) > 1, " are", " is"),
" not installed. (",
pkList,
"). Would you like to try to install",
ifelse(sum(!good) > 1, " them", " it"),
" now?",
sep = ""
)
if (is_interactive() && install_prompt(msg) == 1) {
install_missing(pkg[!good])
} else {
stop("Required packages are missing: ", pkList, call. = FALSE)
}
}
invisible(NULL)
}
## Whether to offer the install. The option makes the prompt reachable from
## tests, which never run interactively.
is_interactive <- function() {
opt <- getOption("caret.interactive")
if (!is.null(opt)) {
return(isTRUE(opt))
}
interactive()
}
## Ask whether to install, returning 1 for yes and 2 for no.
install_prompt <- function(msg) {
cat(msg)
menu(c("yes", "no"))
}
## Install the missing packages, sending the Bioconductor ones to
## BiocManager (the biocLite installer this used to source was retired with
## Bioconductor 3.8).
install_missing <- function(pkg) {
bioc <- c("affy", "logicFS", "gpls", "vbmp")
from_bioc <- pkg[pkg %in% bioc]
from_cran <- pkg[!(pkg %in% bioc)]
if (length(from_cran) > 0) {
install.packages(from_cran)
}
if (length(from_bioc) > 0) {
if (!has_biocmanager()) {
install.packages("BiocManager")
}
BiocManager::install(from_bioc)
}
invisible(pkg)
}
has_biocmanager <- function() {
requireNamespace("BiocManager", quietly = TRUE)
}
#' @rdname modelLookup
#' @export
getModelInfo <- function(model = NULL, regex = TRUE, ...) {
load(system.file("models", "models.RData", package = "caret"))
if (!is.null(model)) {
if (regex) {
keepers <- grepl(model, names(models), ...)
} else {
keepers <- which(model == names(models))[1]
}
models <- models[keepers]
}
if (length(models) == 0) {
stop("That model is not in caret's built-in library")
}
models
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.