print.draws_summary: Print summaries of 'draws' objects

View source: R/summarise_draws.R

print.draws_summaryR Documentation

Print summaries of draws objects

Description

Print output from summarise_draws().

Usage

## S3 method for class 'draws_summary'
print(x, ..., num_args = NULL)

Arguments

x

(draws_summary) A "draws_summary" object as output by summarise_draws().

...

Additional arguments passed to tibble::print.tbl_df()

num_args

(named list) Optional arguments passed to num() for pretty printing of summaries. If NULL (the default), uses the arguments stored in the "num_args" attribute of x, as set by the .num_args argument of summarise_draws(), which itself can be controlled globally via the posterior.num_args option.

Value

An invisible version of the input object.

Examples

x <- example_draws("eight_schools")

# adjust how summaries are printed when calling summarise_draws()...
summarise_draws(x, .num_args = list(sigfig = 2, notation = "dec"))

# ... or when printing
s <- summarise_draws(x)
print(s, num_args = list(sigfig = 2, notation = "dec"))
print(s, num_args = list(digits = 3))

posterior documentation built on Nov. 2, 2023, 5:56 p.m.