This is the documentation for SuperSTAR 9.8

SuperSTAR 9.9 is now available.
View this page in the SuperSTAR 9.9 documentation or visit the SuperSTAR 9.9 documentation home.

Skip to end of metadata
Go to start of metadata

This section describes the options available in the Define Recode window. It is intended as a reference.

If you are new to recodes, see the introduction to recodes in SuperCROSS, which contains a full guide to creating recodes with worked examples.

Define Recode Window

Use the Define Recode window to create and modify recodes:

ElementDescription
Recode Name

The name of the recode.

  • Leave this unchanged to edit the field or recode you opened.
  • Change it to create a new recode field.
Field Values

The list of available values for this field.

If you have a large list of values, right-click and select Find to search for a value.

Recode ValuesThe list of values currently include in the recode. Only values that appear in this list will display in the table.
  • Use Names
  • Use Codes
  • Use Both

Use these options to specify whether to display values using their names, codes, or a combination of both.

Changing this setting will not change any values already added to the Recode Values list. You can therefore use this option to include a combination of names, codes and combinations of both in your recode if necessary.

>> Singly >>Click to add the selected Field Values to the recode as individual items.
>> Group >>

Click to add the selected Field Values to the recode as a group.

Make sure you set the Group Name first before adding the group.

>> Subitems >>For hierarchical fields, click to add
<< Remove <<Click to remove the selected Recode Values from the recode.
Group NameWhen adding a group to the recode, set this to the group name and then click >> Group >>
Total NameWhen creating a total for the recode, select the values you want to include in the total, set this to the total name, and then click Add Total.
Select allClick to select all the Recode Values. You can use this when creating totals and when you need to remove all the values from the recode.
Add TotalClick to add a total to the recode based on the selected Recode Values.
FootnoteEnter text here to display as a footnote whenever the recode is used in a table.

Define Recode Window - Summation Options

When you are recoding the summation options, the Define Recode window has some additional options that only apply to summation options:

ElementDescription
Weight By

The Weight By drop-down list becomes available when you are using a weighted database. The exact options available will depend on the weighting configuration.

Select one of the following:

WeightingDescription
Unweighted SumLets you add unweighted measures with no functions.
Replicate WeightsLets you add functions such as Jack-Knife. If a replicate weight is selected and a non replicate function is added for a measure, the first weight in the replicate weight collection is used in the function.
Main Weight 
Functions

If Unweighted Sum is selected, you can select from the following functions. Click >> Add >> to add the function to the currently selected value in the Recode Values list.

SumThe total of all the values.
MeanThe total of all the values divided by the number of values.
Standard DeviationHow spread out a distribution is, defined as the square root of the variance.
VarianceHow spread out a distribution is. This function is closely related to the Standard Deviation. The variance is defined as the average squared deviation of each number from its mean.
First QuartileCuts off the lowest 25% of data.
Last QuartileThe last quartile cuts off highest 25%.
First Decile (10%)Cuts off the lowest 10%.
Second Decile (20%)Cuts off the lowest 20%.
Third Decile (30%)Cuts off the lowest 30%.
Fourth Decile (40%)Cuts off the lowest 40%.
Median (50%)Cuts the data set in half (the median is the middle of a distribution).
Sixth Decile (60%)Cuts off the lowest 60%.
Seventh Decile (70%)Cuts off the lowest 70%.
Eighth Decile (80%)Cuts off the lowest 80%.
Last Decile (90%)Cuts off the lowest 90%.
GiniA measure of inequality of a distribution, defined as a ratio with values between 0 and 1. The numerator is the area between the Lorenz curve of the distribution and the uniform (perfect) distribution line; the denominator is the area under the uniform distribution line.
Largest (3)Maximum and next 3 largest values from contributing unit records.
Smallest (3)Minimum and next 3 smallest values from contributing unit records.
Count DistinctA count of the number of distinct results.

If Replicate Weights or Main Weight is selected, additional functions will be available to select. The exact functions available will depend on how weighting has been configured.

Confidentiality - At Level

The fact table to use when determining whether to apply the concealment rule. This setting only applies to concealment rules, not to rounding rules.

This setting applies only to concealment rules, not to rounding rules. It is used when the rule is based on the number of contributors to a cell value: SuperCROSS needs to know which fact table to use when counting the number of contributors.

You can also set the level to Default, which means that each measure is summed at its own level. For example, for a database containing two tables, Person and Household:

  • With the level set to Default: contributors to, or percentages for, a measure from the Person table will be counted at the Person level and contributors to or percentages for a measure from the Household table will be counted at the Household level. If there are two people in one household, using a measure from the Person level will count two contributors, but using a measure from the Household level would count only one.
  • With the level set to Household: contributors to or percentages for a measure from either table will be counted at the Household level. If there are two people in one household, and you are using a measure from the Person table, using the Person level will count two contributors, but using the Household level would count only one.
Confidentiality - Rule

A rounding rule (confidentiality or concealment rule) for the selected measure in the Recode Values list. The following rounding rules are available by default without any configuration.

There may also be a number of concealment rules available for selection, if these have been defined in a confid.ini file for this database:

RuleDescriptionEffect of Applying Rule
NoneNo rule is applied to the selected field (when None is selected, no footer displays).None
0-3 RoundingRandomly changes any values of 1 and 2 in the table to either 0 or 3.
  • 0 is not changed
  • 1 is changed to 0 with probability 2/3
  • 1 is changed to 3 with probability 1/3
  • 2 is changed to 0 with probability 1/3
  • 2 is changed to 3 with probability 2/3
  • Values of 3 and above are not changed
Random RoundingAll values/numbers in the table are rounded up or down to base 3. 
1-4 RoundingRandomly changes any values in the table between 1 and 4 inclusive to a random number between 1 and 4 with equal probability distribution.
  • 0 is not changed
  • 1 is changed to 1, 2, 3 or 4 with equal probability
  • 2 is changed to 1, 2, 3 or 4 with equal probability
  • 3 is changed to 1, 2, 3 or 4 with equal probability
  • 4 is changed to 1, 2, 3 or 4 with equal probability
  • Values of 5 and above are not changed.
Graduated Rounding

This rule is similar to random rounding in that all values are rounded. However, the amount by which values are rounded depends on the size of the value.

  • 0 is not changed
  • Values from 1 to 18 are randomly rounded to one of the two nearest multiples of 3
  • Values of 19 randomly round to 18 or 20
  • Values from 20 to 100 randomly round to one of the two nearest multiples of 5
  • Values greater than 100 randomly round to one of the two nearest multiples of 10.

Confidentiality rules may also be configured at the server level, using the Data Control confidentiality plugin. See Confidentiality Rule - Data Control for more information.

Save and Reload Recodes

You can save and reload recodes. See save and load recodes for more information.

Delete a Recode

To delete the recode:

  1. Go to the Fields window.
  2. Select the recoded field (recoded fields appear in bold).
  3. Click Delete.