R/class-PredictionList.R

In simonmoulds/lulcc2: Land Use Change Modelling in R

#' Class PredictionList
#'
#' An S4 class that extends \code{ROCR::\link[ROCR]{prediction-class}} to hold
#' the results of multiple model predictions.
#'
#' @slot prediction a list of \code{ROCR::\link[ROCR]{prediction-class}} objects.
#'   These objects are calculated for each statistical model in the
#'   \code{PredictiveModelList} object supplied to the constructor function
#' @slot categories numeric vector of land use categories for which
#'   \code{prediction} objects were created
#' @slot labels character vector with labels corresponding to \code{categories}
#'
#' @export
#' @exportClass PredictionList
#' @rdname PredictionList-class

setClass("PredictionList",
         slots = c(
           prediction = "list",
           categories = "numeric",
           labels = "character"),
         validity = function(object) {
             ## TODO
             return(TRUE)
         }
)