R/pim.summary-class.R

In pim: Fit Probabilistic Index Models

#' Class pim.summary
#' 
#' This class contains the summary information from a probabilistic index
#' model , and is created by using the function \code{\link{summary}}
#' on an object of the \code{\link{pim-class}}.
#' 
#' The class \code{pim.summary} can be treated like a matrix to get out
#' the coefficients, standard errors, Z values and/or p values. 
#' 
#' @slot formula contains an object of the class \code{\link{pim.formula}}
#' containing the model fitted.
#' @slot model a character vector describing the type of model. See also the argument \code{model} of the function \code{\link{pim}}
#' @slot link a character value that contains the link. See also
#' the argument \code{link} of the function \code{\link{pim}}
#' @slot coef a numeric vector with the coefficients
#' @slot se a numeric vector with the standard errors for the coefficients
#' @slot zval a numeric vector containing the Z values for the coefficients,
#' testing whether the coefficient differs significantly from 0.
#' @slot pr a numeric vector containing the related p-values for the
#' coefficients.
#' @slot h0 a numeric value or a numeric vector containing
#' the null hypothesis. See the argument at \code{\link{summary.pim}}
#' 
#' @seealso \code{\link{pim}} for more info on how to construct the model
#' and \code{\link{summary.pim}} for the constructor.
#' 
#' @include pim-class.R
#' @aliases pim.summary
#' 
setClass(
  'pim.summary',
  slots=c(formula='pim.formula',
          model = 'character',
          link = 'character',
          coef = 'numeric',
          se = 'numeric',
          zval = 'numeric',
          pr = 'numeric',
          h0 = 'numeric'
          ),
  validity = function(object){
    
    if(!.equal.lengths(
      object@coef,
      object@se,
      object@zval,
      object@pr
    )){
      stop("coef, se, zval and pr should be of equal length")
    } else {
      TRUE
    }
       
  }
)