ptable_params-class

An S4 class to represent perturbation parameters

Tabular data from statistical institutes and agencies are mostly
confidential and must be protected prior to publications. The cell-key
method is a post-tabular Statistical Disclosure Control perturbation
technique that adds random noise to tabular data. The statistical
properties of the perturbations are defined by some noise probability
distributions - also referred to as perturbation tables.
This tool can be used to create the perturbation tables based on a maximum
entropy approach as described for example in Giessing (2016)
<doi:10.1007/978-3-319-45381-1_18>. The perturbation tables created can
finally be used to apply a cell-key method to frequency count or magnitude
tables.

Tobias Enderle

ptable

Generation of Perturbation Tables for the Cell-Key Method

ptable_params-class function

<dl>
<dt><code>D</code></dt>
<dd>(integer) parameter for maximum perturbation / noise</dd></dl>
<dt><code>V</code></dt>
<dd>(numeric) parameter for perturbation variance</dd>
<dt><code>js</code></dt>
<dd>(integer) parameter for original counts not to be perturbed</dd>
<dt><code>ncat</code></dt>
<dd>(integer) number of perturbation classes</dd>
<dt><code>pstay</code></dt>
<dd>numeric vector specifying parameter for non-perturbation</dd>
<dt><code>optim</code></dt>
<dd>(integer) specifying optimization parameter for optimization 
function</dd>
<dt><code>mono</code></dt>
<dd>(logical) vector specifying optimization parameter for monotony 
condition</dd>
<dt><code>label</code></dt>
<dd>(character) label for output</dd>
<dt><code>icat</code></dt>
<dd>(integer) categorized original frequencies i</dd>
<dt><code>table</code></dt>
<dd>(character) type of table: frequency counts (<code>cnts</code>) or 
magnitude (<code>nums</code>)</dd>
<dt><code>step</code></dt>
<dd>(integer) step</dd>
<dt><code>type</code></dt>
<dd>(character) indicator for the extra column 'type' used for
magnitude tables: <code>'even'</code>, <code>'odd'</code> or <code>'all'</code></dd>

Slots

An S4 class to represent perturbation parameters — ptable_params-class

<dl>
<dt><code>D</code></dt>
<dd>(integer) parameter for maximum perturbation / noise</dd>


<dt><code>V</code></dt>
<dd>(numeric) parameter for perturbation variance</dd>


<dt><code>js</code></dt>
<dd>(integer) parameter for original counts not to be perturbed</dd>


<dt><code>ncat</code></dt>
<dd>(integer) number of perturbation classes</dd>


<dt><code>pstay</code></dt>
<dd>numeric vector specifying parameter for non-perturbation</dd>


<dt><code>optim</code></dt>
<dd>(integer) specifying optimization parameter for optimization 
function</dd>


<dt><code>mono</code></dt>
<dd>(logical) vector specifying optimization parameter for monotony 
condition</dd>


<dt><code>label</code></dt>
<dd>(character) label for output</dd>


<dt><code>icat</code></dt>
<dd>(integer) categorized original frequencies i</dd>


<dt><code>table</code></dt>
<dd>(character) type of table: frequency counts (<code>cnts</code>) or 
magnitude (<code>nums</code>)</dd>


<dt><code>step</code></dt>
<dd>(integer) step</dd>


<dt><code>type</code></dt>
<dd>(character) indicator for the extra column 'type' used for
magnitude tables: <code>'even'</code>, <code>'odd'</code> or <code>'all'</code></dd>


</dl>

ptable_params-class: An S4 class to represent perturbation parameters

Description

Arguments

Slots