getGroups: Extract Grouping Factors from an emdi Object

In emdi: Estimating and Mapping Disaggregated Indicators

Extract Grouping Factors from an emdi Object

Description

Methods getGroups.direct, getGroups.ebp and getGroups.fh extract grouping factors from an emdi object.

Usage

## S3 method for class 'direct'
getGroups(object, ...)

## S3 method for class 'ebp'
getGroups(object, ...)

## S3 method for class 'fh'
getGroups(object, ...)

Arguments

object	an object of type "emdi", depending on the method either "direct", "ebp" or "fh".
...	additional arguments that are not used in this method.

Details

The generic function getGroups is imported from package nlme and re-exported to make the S3-methods available, even though the nlme package itself is not loaded or attached. For default documentation, see getGroups.

Value

A vector containing the grouping factors.

See Also

direct, ebp, fh, getGroups

Examples

# Example for class direct
emdi_direct <- direct(
  y = "eqIncome", smp_data = eusilcA_smp,
  smp_domains = "district", weights = "weight", threshold = 11064.82,
  var = TRUE, boot_type = "naive", B = 50, seed = 123, X_calib = NULL,
  totals = NULL, na.rm = TRUE
)

getGroups(emdi_direct)

emdi documentation built on Nov. 5, 2023, 5:07 p.m.