fh: Standard Fay-Herriot model for disaggregated indicators

Description Usage Arguments Value

View source: R/FH.R

Description

Function fh estimates indicators using the Fay-Herriot approach by Fay and Herriot (1979). Point estimates of indicators are empirical best linear unbiased predictors (EBLUPs). Additionally, mean squared error (MSE) estimation can be conducted which depends on the chosen estimation approach for the variance of the random effect. For this estimation, six different approaches are provided (see also method). Three different transformation types for the dependent variable can be chosen.

Usage

1
2
3
4
fh(fixed, vardir, combined_data, domains = NULL, method = "reml",
  interval = c(0, 1000), transformation = "no",
  backtransformation = NULL, eff_smpsize = NULL, MSE = FALSE,
  mse_type = "analytical", B = NULL, alpha = 0.05)

Arguments

fixed

a two-sided linear formula object describing the fixed-effects part of the nested error linear regression model with the dependent variable on the left of a ~ operator and the explanatory variables on the right, separated by + operators.

vardir

a character string indicating the name of the variable containing the domain-specific sampling variances of the direct estimators that are included in
combined_data.

combined_data

a data set containing the direct estimates, the sampling variances, the explanatory variables and the domains.

domains

a character string indicating the domain variable that is included in
combined_data. If NULL, the domains are numbered consecutively.

method

a character string describing the method for the estimation of the variance of the random effects. Methods that can be chosen (i) restricted maximum likelihood (REML) method ("reml"), (ii) maximum likelihood method ("ml"), (iii) adjusted REML following Li and Lahiri (2010) ("amrl"), (iv) adjusted ML following Li and Lahiri (2010) ("ampl"), (v) adjusted REML following Yoshimori and Lahiri (2014) ("amrl_yl"), (vi) adjusted ML following Yoshimori and Lahiri (2014) ("ampl_yl"). Defaults to "reml".

interval

interval for the estimation of sigmau2.

transformation

a character that determines the type of transformation and back-transformation. Methods that can be chosen (i) no transformation ("no") (ii) log transformation with naive back-transformation, i.e. simply taking the exponential ("log_naive"), (iii) log transformation with crude back-transformation ("log_crude"), (iv) log transformation with Slud-Maiti back-transformation ("log_SM") and (v) arcsin transformation with naive back-transformation ("arcsin")

backtransformation

a character that determines the type of bracktransformation

eff_smpsize

Effective sample size.

MSE

if TRUE, MSE estimates are calculated. Defaults to FALSE.

mse_type

a character string determining the estimation method of the MSE. Methods that can be chosen (i) analytical MSE depending on the estimation method of the variance of the random effect ("analytical"), (ii) a jackknife MSE ("jackknife"), (ii) a weighted jackknife MSE ("weighted_jackknife"), (iii) and a bootstrap ("boot"). The latter three options are of interest when the arcsin transformation is selected.

B

numeric value that determines the number of bootstrap iterations.

alpha

a numeric value that determines the confidence level for the confidence intervals.

Value

fitted FH model.


akreutzmann/fayherriot documentation built on Aug. 19, 2019, 12:22 p.m.