sdcTable (version 0.32.2)

cell_info: Get information about specific cells

Description

Function cellInfo() can be used to query information of a single cell from a sdcProblem object. If the instance has already been protected using protectTable(), the information is retrieved from the final protected dataset, otherwise from the current state of the instance.

Usage

cell_info(object, specs, ...)

Value

a data.frame with a row for each of the queried cells; the object contains the following columns:

• id: numeric vector of length 1 specifying the numerical index of the cell

• a column strID if object has not yet been protected

• one column for each dimensional variable

• a column freq containing the cell-frequencies

• if available, one column for each (possible) numerical value that was tabulated

• a column sdcStatus with the current sdc code

• is_primsupp: is TRUE if the cell is a primary sensitive cell

• is_secondsupp: is TRUE if the cell is a secondary suppressed cell

Arguments

object

an object of class sdcProblem

specs

input that defines which cells to query; the function expects either (see examples below)

• a named character vector: with names referring to the names of the dimensional variables and the values to its labels. In this case each vector-element must contain a single value (label)

• a data.frame where the column-names refer to the names of the dimensional variables and the values to the labels

...

additional parameters for potential future use, currently unused.

Author

Bernhard Meindl

Examples

# as in makeProblem() with a single primary suppression
p <- sdc_testproblem(with_supps = TRUE)
sdcProb2df(p)

# vector input
specs_vec <- c(region = "D", gender = "male")
cell_info(p, specs = specs_vec)

# data.frame input
specs_df <- data.frame(
  region = c("A", "D", "A"),
  gender = c("male", "female", "female")
)
cell_info(p, specs = specs_df)

# protect the table
p_safe <- protectTable(p, method = "SIMPLEHEURISTIC")

# re-apply
cell_info(p_safe, specs = specs_df)