getData: Return slot 'Data' from an object possibly subsetted to a set...

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

Description

getData returns slot Data from the input object possibly subsetted to those variables specified as an input parameter.

Input objects can be of class:

• StQ: The input parameters are an object of class StQ and a character vector, VarNames, with variable names. It returns the data.table corresponding to slot Data of such an object, but only with variables included in VarNames. If in VarNames only the roots of variable names in the column IDDD of slot Data are specified, it returns a data set with all variables which have those roots.

  If no variable name is specified in VarNames, it returns the complete slot Data.

• StQList: The input parameters are an object of class StQList and a character vector, VarNames, with variable names. It returns a list of StQ objects, but only with variables included in VarNames, as it is explained above.

• rawStQ: The input parameters are an object of class rawStQ and a character vector, VarNames, with variable names. It returns the data.table corresponding to slot Data of such an object, but only with variables included in VarNames.

• rawStQList: The input parameters are an object of class rawStQList and a character vector, VarNames, with variable names. It returns a list of rawStQ objects, but only with variables included in VarNames.

Usage

getData(object, VarNames)

## S4 method for signature 'StQ'
getData(object, VarNames)

## S4 method for signature 'rawStQ'
getData(object, VarNames)

## S4 method for signature 'StQList'
getData(object, VarNames)

## S4 method for signature 'rawStQList'
getData(object, VarNames)

Arguments

object	Object whose (possibly subsetted) slot Data is queried.
VarNames	Character vector with the variable names subsetting the data set.

Value

In the case of StQ/rawStQ objects, it returns a data.table with key-value pair structure corresponding to slot Data from the input object with the values of the variables restricted to variable names specified in VarNames. In the case of StQList/rawStQList objects, it returns a list of StQ/linkS4classrawStQ objects.

Examples

# From an StQ object
VarNames <- c('Employees_1.')
getData(ExampleStQ, VarNames)

VarNames <- c('Turnover')
getData(ExampleStQ, VarNames)

# From a rawStQ object
VarNames <- c('Turnover')
getData(ExamplerawStQ, VarNames)

# From an StQList object
mm <- c(paste0('0', 1:9), 10:12)
TimePer <- paste0('MM', mm, '2015')
QList <- vector('list', 12)
QList <- lapply(QList, function(x) ExampleStQ)
names(QList) <- TimePer
QList <- BuildStQList(QList)
VarNames <- c('Turnover', 'Employees_1.')
getData(QList, VarNames)

david-salgado/StQ documentation built on Aug. 12, 2021, 3:23 p.m.