summary.mcglm: Summary for mcglm Objects

In mcglm: Multivariate Covariance Generalized Linear Models

Summary for mcglm Objects

Description

Produces a comprehensive summary of a fitted mcglm object. The summary includes estimates, standard errors, Wald Z statistics, and p-values for regression, dispersion, power, and correlation parameters. The function can either print the summary to the console or return it invisibly.

Usage

## S3 method for class 'mcglm'
summary(
  object,
  verbose = TRUE,
  print = c("Regression", "power", "Dispersion", "Correlation"),
  ...
)

Arguments

object	A fitted object of class mcglm.
verbose	Logical; if TRUE (default), prints the summary to the console. If FALSE, the summary is returned invisibly.
print	Character vector specifying which components of the summary to print. Possible values are "Regression", "Power", "Dispersion", and "Correlation". Default prints all components.
...	Further arguments passed to or from other methods. Currently ignored.

Details

The summary also prints information about the model fitting, including the link, variance, and covariance functions used, the algorithm method, any correction applied, and the number of iterations completed.

Value

Invisibly returns a list containing summary tables:

• For each response: Regression, Power, Dispersion.

• If applicable: Correlation summary.

Each table contains parameter estimates, standard errors, Wald Z values, and two-sided p-values.

Author(s)

Wagner Hugo Bonat, [e-mail]

See Also

print.mcglm, coef.mcglm, residuals.mcglm

Examples

library(mcglm)
set.seed(123)
mydata <- data.frame(y = rnorm(10), x1 = rnorm(10),
                    x2 = rbinom(10, size = 1, prob = 0.5))
Z0 <- mc_id(mydata)
fit <- mcglm(c(y ~ x1 + x2), matrix_pred = list(Z0), data = mydata)
# Print full summary
summary(fit)
# Get summary invisibly
out <- summary(fit, verbose = FALSE)

mcglm documentation built on Jan. 9, 2026, 1:07 a.m.