in_text: In-Text Summary Statistics

In jackobailey/britpol: Data and Functions for Studying British Politics

In-Text Summary Statistics

Description

Generate in-text summary statistics for posterior distributions from Bayesian models. Most useful when used in Rmarkdown documents.

Usage

in_text(x, text = NULL, suffix = NULL, inside = T, probs = 0.95, digits = 1)

Arguments

x	The distribution to summarise
text	A character string that follows and describes the point estimate.
suffix	A character string that follows each estimate.
inside	Should the median be inside or outside the brackets? Defaults to T.
probs	The level at which to compute the lower and upper bounds. Defaults to 0.95.
digits	How many digits to round the summary statistics to. Defaults to 1.

Value

A text string.

jackobailey/britpol documentation built on Aug. 6, 2023, 2:30 a.m.