print.cat_bayes: Print Summary of 'cat_bayes' Model

In catalytic: Tools for Applying Catalytic Priors in Statistical Modeling

Print Summary of cat_bayes Model

Description

This function prints a formatted summary of a cat_bayes model object, displaying key parameters and settings of the fitted model, including the formula, covariate dimensions, tau (if applicable), family, and algorithm settings, as well as the coefficients' summary.

Usage

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

Arguments

x	An object of class cat_tune, typically resulting from a tuning process, including cat_glm_bayes, cat_glm_bayes_joint, cat_cox_bayes and cat_cox_bayes_joint.
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

This function provides an organized printout of essential details from a Bayesian model fit. It includes the model formula, dimensionality of covariates, model family, Stan algorithm settings, and summary of the model coefficients. If detail is set to TRUE, additional information on interpreting the output is included.

Value

The x object is returned invisibly.

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