getGroupsFormula: Extract Grouping Formula from an emdi Object

In emdi: Estimating and Mapping Disaggregated Indicators

Extract Grouping Formula from an emdi Object

Description

Methods getGroupsFormula.direct, getGroupsFormula.ebp and getGroupsFormula.fh extract the grouping formula from an emdi object.

Usage

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

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

## S3 method for class 'fh'
getGroupsFormula(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 getGroupsFormula 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 getGroupsFormula.

Value

A one-sided formula.

See Also

direct, ebp, fh, getGroupsFormula

Examples

# Example for class ebp
emdi_model <- ebp(
  fixed = eqIncome ~ gender + eqsize + cash + self_empl +
    unempl_ben + age_ben + surv_ben + sick_ben + dis_ben + rent + fam_allow +
    house_allow + cap_inv + tax_adj, pop_data = eusilcA_pop,
  pop_domains = "district", smp_data = eusilcA_smp, smp_domains = "district",
  na.rm = TRUE
)

getGroupsFormula(emdi_model)

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