R/00model_classes.R

In plssem: Complex Partial Least Squares Structural Equation Modeling

#' @import methods
NULL

PLS_MODEL <- "ANY" # NULL or PlsModel
PAR_TABLE <- "ANY" # NULL or data.frame/PlsSemParTable
LIST      <- "ANY" # NULL or list
MATRIX    <- "ANY"


setClass(
  "GlsPathModel",
  slots     = c(
    matrices  = "list",
    info      = "list",
    parTable  = "data.frame"
  ),
  prototype = list(
    matrices  = list(
      psi         = NULL,
      gamma       = NULL,
      psi.free    = NULL,
      gamma.free  = NULL,
      I           = NULL,
      S           = NULL,
      S.inv       = NULL
    ),
    info = list(
      start     = numeric(0L),
      npar      = 0,
      idx.psi   = integer(0L),
      idx.gamma = integer(0L),
      k         = 0,
      etas      = character(0L)
    ),
    parTable = data.frame()
  )
)


setClass(
  "ThresholdStruct",
  slots     = c(
    ordered     = "character",
    indices     = "list",
    thresholds  = "numeric",
    proportions = "numeric",
    levels      = "list",
    digits      = "integer"
  ),
  prototype = list(
    ordered     = character(0L),
    indices     = vector("list", 0L),
    thresholds  = numeric(0L),
    proportions = numeric(0L),
    levels      = vector("list", 0L),
    digits      = 5L
  )
)


setClass(
  "PlsModel",
  slots     = c(
    matrices         = "list",
    data             = "matrix",
    info             = "list",
    thresholdStruct  = "ThresholdStruct",
    glsPathModel     = "GlsPathModel",
    status           = "list",
    params           = "list",
    fit              = "list",
    fitConsistent    = "list",
    fitUncorrected   = "list",
    fitLmer          = LIST,     # NULL or list
    factorScores     = MATRIX,   # NULL or matrix
    parTableInput    = "data.frame",
    higherOrderModel = PLS_MODEL, # NULL or PlsModel
    combinedModel    = PLS_MODEL, # NULL or PlsModel
    parTable         = PAR_TABLE, # NULL or data.frame/PlsSemParTable
    boot             = "list"
  ),
  prototype = list(
    matrices         = list(),
    data             = matrix(numeric(0), 0, 0),
    info             = list(),
    thresholdStruct  = methods::new("ThresholdStruct"),
    glsPathModel     = methods::new("GlsPathModel"),
    status           = list(),
    params           = list(),
    fit              = list(),
    fitConsistent    = list(),
    fitUncorrected   = list(),
    fitLmer          = NULL,
    factorScores     = NULL,
    parTableInput    = data.frame(),
    higherOrderModel = NULL,
    combinedModel    = NULL,
    parTable         = NULL,
    boot             = list()
  )
)