coef-VGMSFH-method: Extract Coefficients from a VGMSFH Object

In vmsae: Variational Multivariate Spatial Small Area Estimation

Extract Coefficients from a VGMSFH Object

Description

This method extracts posterior mean estimates of model coefficients from a VGMSFH object. It can return either fixed effect coefficients or spatial random effects.

Usage

## S4 method for signature 'VGMSFH'
coef(object, var_idx = 1, type = "fixed")

Arguments

object	An object of class VGMSFH.
var_idx	Integer. The index of the variable of interest (for multivariate models). Default is 1.
type	Character. The type of coefficient to extract. Options are: "fixed" – extract the posterior mean of fixed effect coefficients (default). "spatial" – extract the posterior mean of spatial random effects.

Value

A numeric vector of posterior means for the selected coefficient type.

Examples

library(vmsae)
example_model <- readRDS(system.file("example", "example_model.Rds", package = "vmsae"))
coef(example_model)  # Get fixed effect coefficients
coef(example_model, type = "spatial")  # Get spatial random effects

vmsae documentation built on June 21, 2025, 9:07 a.m.