View source: R/hbm_binlogitnorm.R
hbm_binlogitnorm | R Documentation |
This function implements a Hierarchical Bayesian Small Area Estimation (HBSAE)
under a Logit-Normal Model using Bayesian inference with the brms
package.
The model accounts for fixed effects, random effects, spatial random effects (CAR/SAR models), and measurement error correction, allowing for robust small area estimation.
The function utilizes the Bayesian regression modeling framework provided by brms
,
which interfaces with 'Stan' for efficient Markov Chain Monte Carlo (MCMC) sampling.
The brm()
function from brms
is used to estimate posterior distributions based on user-defined
hierarchical and spatial structures.
hbm_binlogitnorm(
response,
trials,
predictors,
group = NULL,
sre = NULL,
sre_type = NULL,
car_type = NULL,
sar_type = NULL,
M = NULL,
data,
handle_missing = NULL,
m = 5,
prior = NULL,
control = list(),
chains = 4,
iter = 4000,
warmup = floor(iter/2),
cores = 1,
sample_prior = "no",
...
)
response |
The dependent (outcome) variable in the model. This variable represents the count of successes in a Binomial distribution. |
trials |
Specifies the number of trials in a binomial model. This is required for binomial family models where the response variable is specified as a proportion. |
predictors |
A list of independent (explanatory) variables used in the model. These variables form the fixed effects in the regression equation. |
group |
The name of the grouping variable (e.g., area, cluster, region) used to define the hierarchical structure for random effects. This variable should correspond to a column in the input data and is typically used to model area-level variation through random intercepts |
sre |
An optional grouping factor mapping observations to spatial locations. If not specified, each observation is treated as a separate location. It is recommended to always specify a grouping factor to allow for handling of new data in postprocessing methods. |
sre_type |
Determines the type of spatial random effect used in the model. The function currently supports "sar" and "car" |
car_type |
Type of the CAR structure. Currently implemented are "escar" (exact sparse CAR), "esicar" (exact sparse intrinsic CAR), "icar" (intrinsic CAR), and "bym2". |
sar_type |
Type of the SAR structure. Either "lag" (for SAR of the response values) or "error" (for SAR of the residuals). |
M |
The M matrix in SAR is a spatial weighting matrix that shows the spatial relationship between locations with certain weights, while in CAR, the M matrix is an adjacency matrix that only contains 0 and 1 to show the proximity between locations. SAR is more focused on spatial influences with different intensities, while CAR is more on direct adjacency relationships. If sre is specified, the row names of M have to match the levels of the grouping factor |
data |
Dataset used for model fitting |
handle_missing |
Mechanism to handle missing data (NA values) to ensure model stability and avoid estimation errors.
Three approaches are supported.
The |
m |
Number of imputations to perform when using the |
prior |
Priors for the model parameters (default: |
control |
A list of control parameters for the sampler (default: |
chains |
Number of Markov chains (default: 4) |
iter |
Total number of iterations per chain (default: 2000) |
warmup |
Number of warm-up iterations per chain (default: floor(iter/2)) |
cores |
Number of CPU cores to use (default: 1) |
sample_prior |
(default: "no") |
... |
Additional arguments |
A hbmfit
object
Saniyyah Sri Nurhayati
Rao, J. N. K., & Molina, I. (2015). Small Area Estimation. John Wiley & Sons, page 390. Gelman, A. (2006). Prior Distributions for Variance Parameters in Hierarchical Models (Comment on Article by Browne and Draper). Bayesian Analysis, 1(3), 527–528. Gelman, A., Jakulin, A., Pittau, M. G., & Su, Y. S. (2008). A Weakly Informative Default Prior Distribution for Logistic and Other Regression Models.
# Load the example dataset
library(hbsaems)
data("data_binlogitnorm")
# Prepare the dataset
data <- data_binlogitnorm
# Fit Logit-Normal Model
model1 <- hbm_binlogitnorm(
response = "y",
trials = "n",
predictors = c("x1", "x2", "x3"),
data = data
)
summary(model1)
# Fit Logit-Normal Model with Grouping Variable as Random Effect
model2 <- hbm_binlogitnorm(
response = "y",
trials = "n",
predictors = c("x1", "x2", "x3"),
group = "group",
data = data
)
summary(model2)
# Fit Logit-Normal Model With Missing Data
data_miss <- data
data_miss[5:7, "y"] <- NA
# a. Handling missing data by deleted (Only if missing in response)
model3 <- hbm_binlogitnorm(
response = "y",
trials = "n",
predictors = c("x1", "x2", "x3"),
data = data_miss,
handle_missing = "deleted"
)
summary(model3)
# b. Handling missing data using multiple imputation (m=5)
model4 <- hbm_binlogitnorm(
response = "y",
trials = "n",
predictors = c("x1", "x2", "x3"),
data = data_miss,
handle_missing = "multiple"
)
summary(model4)
# Fit Logit-Normal Model With Spatial Effect
data("adjacency_matrix_car")
M <- adjacency_matrix_car
model5 <- hbm_binlogitnorm(
response = "y",
trials = "n",
predictors = c("x1", "x2", "x3"),
sre = "sre",
sre_type = "car",
M = M,
data = data
)
summary(model5)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.