R/caret.r

In emil: Evaluation of Modeling without Information Leakage

#' Fit a model using the \pkg{caret} package
#' 
#' @param x Descriptors.
#' @param y Response.
#' @param ... Sent to \code{\link[caret]{train}}.
#' @author Christofer \enc{Bäcklin}{Backlin}
#' @references Kuhn M (2008). “Building Predictive Models in R Using the caret Package.
#'   Journal of Statistical Software, 28(5), 1–26. doi:10.18637/jss.v028.i05.
#'   caret: Classification and Regression Training. R package version 6.0-79,
#'   URL https://CRAN.R-project.org/package=caret.
#' @export
fit_caret <- function(x, y, ...){
    nice_require("caret")
    caret::train(x, y, ...)
}

#' Predict using a \pkg{caret} method
#' 
#' This is not guaranteed to work with all \pkg{caret} methods. If it doesn't 
#' work for a particular method, the user will need to rewrite it.
#'
#' @param object Fitted caret model.
#' @param x New data to predict the response of.
#' @param ... Sent to \code{\link{predict}} that forwards it to the
#'   appropriate predict function in the \pkg{caret} package.
#' @author Christofer \enc{Bäcklin}{Backlin}
#' @export
predict_caret <- function(object, x, ...){
    nice_require("caret")
    tryCatch(
        list(prediction = predict(object = object, newdata = x, ...)),
        error = function(...){
            stop("When using the `caret` package to fit and tune models within the `emil` framework, you may need to supply your own prediction function.")
        }
    )
}