setValues: Method to set values of a variable

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

Description

setValues sets the values of a variable in the input object.

This method creates a variable with the name VarName with values specified in the input Value. If the variable is already present in the input variable, the method overwrites it.

It is also necessary to provide as input parameter an object of class DD named newDD with the row corresponding to the variable set with this method to be included in the slot DD. This row is specified as a data.table with a single row and columns Variable, Sort, Class, Qual1-Qualn (as many as so many qualifiers are necessary) and ValueRegExp.

Input parameters by and lag are optional and specify how to compute the values of the new variable in some circunstamces.

Usage

setValues(object, newDD, DDslot = "MicroData", Value, lag = NULL, by = NULL)

## S4 method for signature 'StQ,DD'
setValues(object, newDD, DDslot = "MicroData", Value, lag = NULL, by = NULL)

## S4 method for signature 'StQList,DD'
setValues(object, newDD, DDslot = "MicroData", Value, lag = NULL, by = NULL)

Arguments

object	Object in which to include the new variable.
newDD	DD object with the information of the new variable needed for the slot DD of the input object.
DDslot	Character vector of length 1 with the name of the slot of newDD in which the new variable is defined. Its default value is MicroData.
Value	Vector of length the number of statistical units in the input object with the values of the new variable for each of these units or alternatively an object of class call with a mathematical formula for the computation of these values.
lag	Integer vector of length 1 with the lag to use when the input object is of class StQList. Its default value is NULL. If its value is not NULL, it is not possible to use an object of class call in "Value".
by	Character vector with the names of the variables specifying those statistical units groups under which the mathematical formula will be applied. Its default value is NULL.

Value

Object of the same class as the input object with the new variable included.

Examples

## Not run: 
library(data.table)
data(ExampleStQ)
newVNCVar <- data.table(IDQual = '', NonIDQual = '', IDDD = 'lTurnover',
                            UnitName = '', InFiles = 'FF')
newVNC <- BuildVNC(list(MicroData = newVNCVar))
newDD <- DD(VNC = newVNC, 
            MicroData = data.table(Variable = 'lTurnover',
                                   Sort = 'IDDD',
                                   Class = 'numeric',
                                   Length = '10',
                                   Qual1 = 'ID',
                                   ValueRegExp = ''))
NewQ <- setValues(object = ExampleStQ,
               newDD = newDD,
               DDslot = 'MicroData',
               Value = log(1 + as.numeric(Turnover)))
getValues(NewQ, 'lTurnover')

## End(Not run)

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