NumSingleton: Decoding of 'singletonMethod'

View source: R/NumSingleton.R

NumSingletonR Documentation

Decoding of singletonMethod

Description

A GaussSuppression singletonMethod starting with "num" is decoded into separate characters.

Usage

NumSingleton(singletonMethod)

Arguments

singletonMethod

String to be decoded. If necessary, the input string is extended with F's.

Details

Any F means the feature is turned off. Other characters have the following meaning:

  1. singleton2Primary (1st character):

    • T: All singletons are forced to be primary suppressed.

    • t: Non-published singletons are primary suppressed.

  2. integerUnique (2nd character):

    • T: Integer values representing the unique contributors are utilized. Error if singleton not supplied as integer.

    • t: As T above, but instead of error, the feature is turned off (as F) if singleton is not supplied as integer.

  3. sum2 (3rd character):

    • T: Imaginary primary suppressed cells are made, which are the sum of some suppressed inner cells and which can be divided into two components. At least one component is singleton contributor. The other component may be an inner cell.

    • H: As T above. And in addition, the other component can be any primary suppressed published cell. This method may be computationally demanding for big data.

Value

A character vector or NULL

Examples

NumSingleton("numTFF")
NumSingleton("numFTT")
NumSingleton("numttH")

SSBtools documentation built on July 9, 2023, 6:16 p.m.