R/setRegressands.R

In david-salgado/categObsPredModelParam: Class and methods for the parameters of a categorical observation- prediction model

#' @title Set value of component Regressands of an object \linkS4class{categObsPredModelParam}
#'
#' @description \code{setRegressands} assigns a character value to the component \code{Regressands}
#' of the slot \code{VarRoles} of the input object \linkS4class{categObsPredModelParam}.
#'
#' @param object Object \linkS4class{categObsPredModelParam} whose component \code{Regressands}
#' is to be assigned.
#'
#' @param value character vector to be assigned to the component \code{Regressands}.
#'
#' @return Object \linkS4class{categObsPredModelParam} with the component \code{Regressands}
#' updated.
#' 
#' @importFrom methods validObject
#'
#' @include categObsPredModelParam-class.R
#'
#' @rdname setRegressands
#'
#' @export
setGeneric("setRegressands<-", function(object, value){standardGeneric("setRegressands<-")})
#'
#' @rdname setRegressands
#' 
#' @export
setReplaceMethod(
  f = "setRegressands",
  signature = c("categObsPredModelParam", "character"),
  function(object, value){

    object@VarRoles$Regressands <- value
    validObject(object)
    return(object)
  }
)