Relative Standard Error - Data Control

The Relative Standard Error (RSE) plugin allows you to show RSE figures in SuperWEB2 for weighted databases.

Relative Standard Error Module

SuperSERVER is supplied with a Data Control plugin called rsecalculationmodule.dll. This plugin calculates RSE values for display in SuperWEB2.

The RSE calculation is performed only on non empty cells that have associated Main and Replicate weights.

Module Properties

The rsecalculationmodule.dll plugin has a number of properties you can configure.

Property	Description
Formula	The formula used to calculate the RSE: Formula Description jackknife The jackknife variance estimator is given by: Where G is the total number of replicate weights and repg=gth This is the default formula. bootstrap The bootstrap variance estimator is given by: The following formula is used to obtain the value of the bootstrap estimate, given the jackknife:  RSE values are supposed to be in the range of 0 and 1. However, these formulas do not guarantee that calculated RSE values are always in the range of 0 and 1. Calculated values may be greater than 1 in some cases.
UnreliableRseThreshold	The RSE calculation module calculates the table reliability based on the portion of unreliable cells exceeding a defined threshold. Use this property to set the unreliable RSE threshold. Any cell with an RSE value greater than or equal to this threshold is considered unreliable. The table reliability calculation always excludes empty cells (cells with no contributors).
UnreliableTableThreshold	A percentage value. When the percentage of unreliable cells and total non-empty cells is greater than or equal to this percentage, the table results are considered unreliable.
Message	A configurable message that will be displayed to the user in SuperWEB2 when the table results are considered unreliable. The message is a warning only (end users can still view numeric results).

Apply the Plugin to a Database

1. Login to SuperADMIN and create a new mandatory method (the ID and display name can be whatever you choose; in this example the method is called "rse"):

   CODE

   > method addmethod rse mandatory rse

2. Add the Data Control plugin to the method:

   CODE

   > method rse adddcplugin rsecalculationmodule rsecalculationmodule.dll 1

3. Set the plugin properties:

   CODE

   > method rse rsecalculationmodule addproperty Message "Table is not reliable"
   > method rse rsecalculationmodule addproperty UnreliableRseThreshold "0.25"
   > method rse rsecalculationmodule addproperty UnreliableTableThreshold "2%"
   > method rse rsecalculationmodule addproperty Formula "jackknife"

   In this case we have set the thresholds to 0.25 and 2% and selected the jackknife formula.

4. Assign the method to a database (in this example we are assigning the method to a database with the ID weightedsurvey2013:

   CODE

   > cat weightedsurvey2013 addmethod rse

   You can review the method details using the command cat <database_id> methods details <method_id>:

   CODE

   > cat weightedsurvey2013 methods details rse
   [ Method : rse (id:rse) (type:mandatory) ]
       [ Common ]
       [ DCPlugin : rsecalculationmodule.dll (id:rsecalculationmodule) (priority:1) ]
           [ Message : Table is not reliable ]
           [ UnreliableRseThreshold : 0.25 ]
           [ UnreliableTableThreshold : 2% ]
           [ Formula : jackknife ]

RSE Annotation Module

SuperSERVER is also supplied with a Data Control plugin called rseannotationmodule.dll. This plugin provides annotations for RSE values.

The module annotates cells based on:

• the RSE absolute value of the cells
• a defined set of values in a lookup table
• a lookup operator
• static annotations in the static annotation repository.

Only one lookup table can be used in a configured instance of rseannotationmodule.

Only one lookup operator can be used in a configured instance of rseannotationmodule.

Module Properties

The rseannotationmodule.dll plugin has two properties that you must configure.

For example:

1.00 ****
0.75 ***
0.50 **
0.25 *

Apply the Plugin to a Database

1. Login to SuperADMIN and create a new method:

   CODE

   > method addmethod rse-annotation

2. Add the Data Control plugin to the method:

   CODE

   > method rse-annotation adddcplugin rse-annotation-module rseannotationmodule.dll 1

3. Set the plugin properties:

   CODE

   > method rse-annotation rse-annotation-module addproperty LookupTable "lookup_table.txt"
   > method rse-annotation rse-annotation-module addproperty LookupOperator ">"

   

   You can specify the lookup table file name using either an absolute path or a path relative to the location of the plugin DLL. You must escape any Windows style directory separators (\) in the path with a backslash.

   For example:

   CODE

   > method rse-annotation rse-annotation-module addproperty LookupTable "C:\\database\\config\\lookup_table.txt"

4. Assign the method to a database (in this example we are assigning the method to a database with the ID weightedsurvey2013:

   CODE

   > cat weightedsurvey2013 addmethod rse-annotation

   You can review the method details using the command cat <database_id> methods details <method_id>:

   CODE

   > cat weightedsurvey2013 methods details rse-annotation
   [ Method : rse-annotation (id:rse-annotation) (type:mandatory) ]
       [ Common ]
       [ DCPlugin : rseannotationmodule.dll (id:rse-annotation-module) (priority:1) ]
           [ LookupTable : lookup_table.txt ]
           [ LookupOperator : > ]