R/setDD.R

In david-salgado/StQ: Tools to manage metadata-incorporated key-value pair datasets

#' @title Set value of slot \code{DD}
#'
#' @description \code{setDD} assigns an object of class \link{DD} to the slot \code{DD} of 
#' the input object.
#'
#' @param object Object whose slot \code{DD} is to be set.
#'
#' @param value Object of class \link{DD} to be assigned to the input object.
#'
#' @return Object of class \link{StQ} with slot DD updated.
#'
#' @examples
#' # We build an empty StQ object:
#' library(data.table)
#' Q <- StQ()
#'
#' # We use an DD object previously created:
#' data(ExampleDD)
#' # We assign this DD object to slot DD of the preceding StQ object:
#' setDD(Q) <- ExampleDD
#' str(Q)
#'
#' @rdname setDD
#' 
#' @include StQ.R
#'
#' @export
setGeneric("setDD<-", function(object, value){standardGeneric("setDD<-")})
#' @rdname setDD
#'
#' @import data.table
#'
#' @export
setReplaceMethod(
    f = "setDD",
    signature = c("StQ", "DD"),
    function(object, value){

        object[['DD']] <- value
        return(object)
    }
)