R/ML_QDAModel.R

Defines functions QDAModel

Documented in QDAModel

#' Quadratic Discriminant Analysis Model
#'
#' Performs quadratic discriminant analysis.
#'
#' @param prior prior probabilities of class membership if specified or the
#'   class proportions in the training set otherwise.
#' @param method type of mean and variance estimator.
#' @param nu degrees of freedom for \code{method = "t"}.
#' @param use type of parameter estimation to use for prediction.
#'
#' @details
#' \describe{
#'   \item{Response types:}{\code{factor}}
#' }
#'
#' The \code{\link{predict}} function for this model additionally accepts the
#' following argument.
#' \describe{
#'   \item{\code{prior}}{prior class membership probabilities for prediction data
#'     if different from the training set.}
#' }
#'
#' Default argument values and further model details can be found in the source
#' See Also links below.
#'
#' @return \code{MLModel} class object.
#'
#' @seealso \code{\link[MASS]{qda}}, \code{\link[MASS]{predict.qda}},
#' \code{\link{fit}}, \code{\link{resample}}
#'
#' @examples
#' fit(Species ~ ., data = iris, model = QDAModel)
#'
QDAModel <- function(
  prior = numeric(), method = c("moment", "mle", "mve", "t"), nu = 5,
  use = c("plug-in", "predictive", "debiased", "looCV")
) {

  method <- match.arg(method)
  use <- match.arg(use)

  MLModel(

    name = "QDAModel",
    label = "Quadratic Discriminant Analysis",
    packages = "MASS",
    response_types = "factor",
    predictor_encoding = "model.matrix",
    na.rm = TRUE,
    params = new_params(environment()),

    fit = function(formula, data, weights, use, ...) {
      res <- eval_fit(
        data,
        formula = MASS::qda(formula, data = data, na.action = na.pass, ...),
        matrix = MASS::qda(x, y, ...)
      )
      attr(res, ".MachineShop") <- list(use = use)
      res
    },

    predict = function(
      object, newdata, prior = object$prior, .MachineShop, ...
    ) {
      newdata <- as.data.frame(newdata)
      predict(object, newdata = newdata, prior = prior,
              method = .MachineShop$use)$posterior
    }

  )

}

MLModelFunction(QDAModel) <- NULL
brian-j-smith/MachineShop documentation built on Sept. 22, 2023, 10:01 p.m.