Skip to end of metadata
Go to start of metadata
SummaryUsed in conjunction with other modules to update RSE for sums and means to take into account the effect of continuous perturbation. This module adds the ability to perturb the population mean values in the variance cube. In order to use the module, you must have the FREQ cube enabled and have a VTable available to lookup the correction value.
Filenameperturbedmeanvariance
Dependencies
  • Continuous Perturbation
  • Perturbed Continuous RSE
Priority

The Perturbation modules must be configured to run in the following sequence:

  1. Perturbation.
  2. Continuous Perturbation.
  3. RSE Calculation.
  4. Perturbed Population Estimate Variance.
  5. Perturbed Mean Variance.
  6. Average Cell Weight.
  7. Perturbed Continuous RSE.
  8. Perturbed Count RSE.

Configuration

method addmethod <method_id> [{table|mandatory}] [<display_name>]
method <method_id> adddcplugin <plugin_id> perturbedmeanvariance [<priority>]
method <method_id> <plugin_id> addproperty VTable <vtable_path>
method <method_id> <plugin_id> addproperty FTABLE <ftable_path>

Example

The following example shows the configuration of the Perturbed Mean Variance module in context but does not show the full configuration for the other modules (refer to the reference pages for the individual modules for more details about their configuration).

method addmethod MethodID

method MethodID adddcplugin Perturbation perturbation

method MethodID adddcplugin ContPerturbation continuousperturbationmodule
method MethodID ContPerturbation addproperty VTable "C:\\config\\vtable.csv"
method MethodID ContPerturbation addproperty FTABLE "C:\\config\\ftable.csv"

method MethodID adddcplugin RSECalculationModule rsecalculationmodule

method MethodID adddcplugin PerturbedPopEstVariance perturbedpopestvariance

method MethodID adddcplugin PerturbedMeanVariance perturbedmeanvariance
method MethodID PerturbedMeanVariance addproperty VTable "C:\\config\\vtable.csv"
method MethodID PerturbedMeanVariance addproperty FTABLE "C:\\config\\ftable.csv"

method MethodID adddcplugin AverageCellWeight average_cellwgt

method MethodID adddcplugin PerturbedEstimates perturbedestimates

method MethodID adddcplugin PerturbedContinuousRSE perturbedContinuousRSE

method MethodID adddcplugin PerturbedCountsRSE perturbedCountsRSE

Properties

VTable

The location and name of the VTable. This must be the same VTable as used by the Continuous Perturbation module.

The VTable is a CSV file containing two columns with no header:

  • The first column is a list of contributor counts.
  • The second column contains the correction value for those contributor counts.
FTABLE

The location and name of the FTable. This must be the same FTable as used by the Continuous Perturbation module.

The FTable is a CSV file containing two columns with no header:

  • The first column represents the rank (with respect to TOPN) and must be an integer value, starting at 1 in the first row and incrementing for each additional row (1,2,3, etc).
  • The second column represents the scaling factor and must be a number (can be a floating point value).

Any backslashes in the file paths must be escaped with an additional backslash (forward slashes can also be used but do not need to be escaped).

  • No labels