R/NB-methods.R

In targeted: Targeted Inference

##' @export
print.NB <-
function(x, ...) {
    print(x$call)
    cat("\n")
    val <- x$prior
    names(val) <- paste0(seq(length(val)), ": ", names(val))
    print(data.table::data.table(Prior=val))
    cat("\n")
}


#' @title NB class object
#'
#' @description The functions \code{\link{NB}} returns an object of the type
#'   \code{NB}.
#'
#' An object of class '\code{NB}' is a list with at least the following components:
#'
#' \describe{
#'   \item{prior}{Matrix with prior probabilities, i.e. marginal class probabilities Pr(class)}
#'   \item{pcond}{list of matrices with conditional probabilities of the features given
#'         the classes (one list element per class), Pr(x|class)}
#'   \item{classes}{Names (character vector) of the classes}
#'   \item{xvar}{number of repetitions of the CV}
#'   \item{xmodel}{Number of folds of the CV}
#'   \item{model}{Number of folds of the CV}
#' }
#'
#' @section S3 generics:
#' The following S3 generic functions are available for an object of class \code{NB}:
#' \itemize{
#'   \item{\code{predict}}{Predict class probabilities for new features data.}
#'   \item{\code{print}}{Basic print method.}
#'  }
#'
#' @aliases NB-class
#' @seealso \code{\link{NB}}, \code{\link{NB2}}
#' @return objects of the S3 class '\code{NB}'
#' @examples ## See example(NB) for examples
#' @docType class
#' @name NB-class
NULL