print.cat_gibbs: Print Summary of 'cat_gibbs' Model

In catalytic: Tools for Applying Catalytic Priors in Statistical Modeling

Print Summary of cat_gibbs Model

Description

This function prints a summary of the cat_gibbs model, displaying details about the formula, covariate dimensions, family, coefficients, and Gibbs sampling settings.

Usage

## S3 method for class 'cat_gibbs'
print(x, digit = 3, detail = TRUE, ...)

Arguments

x	A cat_gibbs model object containing the results of a Bayesian GLM fitted using Gibbs sampling.
digit	An integer indicating the number of decimal places for printing coefficient estimates. Default is 3.
detail	A logical value indicating whether to include additional detailed output at the end of the summary. If TRUE, it will print additional interpretation help.
...	Additional parameters to pass to other functions.

Details

The summary includes:

• The function name and formula used in the model.

• Dimensions of the covariate matrix.

• Family and link function details.

• Sampling information, including the total iterations, warm-up iterations, and effective Gibbs sampling post-warmup.

• Coefficients with summary statistics and effective sample size.

If detail is set to TRUE, additional guidance for interpreting the printed output is provided.

Value

The x object is returned invisibly.

catalytic documentation built on April 4, 2025, 5:51 a.m.