ranef: Extract Random Effects of emdi Objects

In emdi: Estimating and Mapping Disaggregated Indicators

Extract Random Effects of emdi Objects

Description

Methods ranef.ebp and ranef.fh extract the fixed effects from an emdi object of class "ebp" or "fh".

Usage

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

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

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

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

Arguments

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

Details

The alias random.effects can also be used instead of ranef. The generic function ranef 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 random.effects.

Value

A vector containing the estimated random effects at domain level is returned.

See Also

ebp, fh, random.effects

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
)

ranef(emdi_model)

emdi documentation built on June 22, 2024, 9:46 a.m.