R/StQList.R

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

#' @title S4 class to implement a named list of objects of class \link{StQ}
#'
#' @description Definition of an S4 class of name \code{StQList} with a list of objects of class
#' \link{StQ}. Instead of an atomic vector as a name, we associate with it an object of class
#' \linkS4class{RepoTimeInt} containing the names of the time periods corresponding to each
#' \link{StQ} object.
#'
#' The structure of this S4 class \code{StQList} comprises 2 attributes:
#'
#' \itemize{
#'
#' \item the attribute \code{Data}, which is a \code{list} of objects of class \link{StQ};
#'
#' \item  the attribute \code{Periods}, which is an object of class \linkS4class{RepoTimeInt}.
#' }
#'
#' @param Data \code{List} of objects of class \link{StQ};
#'
#' @param Periods An object of class \linkS4class{RepoTimeInt};
#'
#' @examples
#' mm <- c(paste0('0', 1:9), 10:12)
#' TimePer <- paste0('MM', mm, '2015')
#' PeriodList <- RepoTime::newRepoTime(TimePer)
#' EmptyQ <- StQ()
#' EmptyQList <- vector('list', 12)
#' EmptyQList <- lapply(EmptyQList, function(x) EmptyQ)
#' QList <- StQList(Data = EmptyQList, Periods = PeriodList)
#' QList
#' str(QList)
#'
#' @include StQ.R
#' 
#' @export
StQList <- function(Data = list(), Periods = new(Class = 'RepoTimeInt')){
    
    object <- list(Data = Data, Periods = Periods)
    PeriodClass <- object$Periods
    if (length(object$Data) != length(RepoTime::getRepo(PeriodClass))) {
        
        stop('[StQList::validity] The lenght of both slots must be equal.')
    }
    if (length(object$Data) != 0){
    
        CorrectClass <- unlist(lapply(object$Data, inherits, 'StQ'))

        if (!all(CorrectClass)) {
                 
            stop('[StQList::validity] Every component of slot Data must be of class StQ.')
        }
    }
             
    class(object) <- append("StQList", class(object))
    return(object)    
}

setOldClass(c('list'))
setOldClass(c('StQList', 'list'))