extract_stan_summary: Extract and Format Summary of Stan Model Results

View source: R/prints.R

extract_stan_summaryR Documentation

Extract and Format Summary of Stan Model Results

Description

This function extracts the summary statistics from a fitted Stan model stored within a x object, formats the parameter names, and rounds values to a specified number of decimal places. By default, the function includes an intercept term in the summary if present.

Usage

extract_stan_summary(x, digit = 3, with_intercept = TRUE)

Arguments

x

A model object generated from catalytic that containing a fitted Stan model.

digit

An integer specifying the number of decimal places to which the summary statistics should be rounded. Default is 3.

with_intercept

A logical value indicating whether the intercept should be included in the summary. If TRUE, the intercept is labeled and included in the formatted output. Default is TRUE.

Value

A matrix of rounded summary statistics from the Stan model, with row names representing parameter labels and columns containing summary values.


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