get_safeobj: Query information from protected problem instances

View source: R/utils_safeObj.R

get_safeobjR Documentation

Query information from protected problem instances

Description

get_safeobj() allows to extract information from protected sdcProblem instances.

Usage

get_safeobj(object, type, ...)

Arguments

object

an object of class sdcProblem

type

a character vector defining what should be returned. Possible choices are:

  • ⁠"dimInfo⁠": get infos on dimensional variables that formed the base of the protected data

  • ⁠"finalData⁠": return final data object

  • ⁠"nrNonDuplicatedCells⁠": total number of cells that are duplicates

  • ⁠"nrPrimSupps⁠": total number of primary suppressed cells

  • ⁠"nrSecondSupps⁠": total number of secondary cell suppressions

  • ⁠"nrPublishableCells⁠": total number of cells that can be published

  • ⁠"suppMethod⁠": suppression method that has been used

  • ⁠"cellInfo⁠": extract information about a specific cell

  • ⁠"cellID⁠": calculate ID of a specific cell defined by level-codes and variable names

...

additional argument required for choices "cellInfo" and "cellID"

  • "specs": a named character vector with names relating to the names of the dimensional variables and values to levels of the hierarchies.

  • "complete": if TRUE, the entire row is returned in "cellID", otherwise only the cell id (number)

  • "verbose": toggles additional output

Value

the required information.

Note

internal function

Author(s)

Bernhard Meindl bernhard.meindl@statistik.gv.at


sdcTable documentation built on Aug. 11, 2023, 9:06 a.m.