print.draws_array: Print 'draws_array' objects

View source: R/print.R

print.draws_arrayR Documentation

Print draws_array objects

Description

Pretty printing for draws_array objects.

Usage

## S3 method for class 'draws_array'
print(
  x,
  digits = 2,
  max_iterations = getOption("posterior.max_iterations", 5),
  max_chains = getOption("posterior.max_chains", 8),
  max_variables = getOption("posterior.max_variables", 4),
  reserved = FALSE,
  ...
)

Arguments

x

(draws) A draws object or another R object for which the method is defined.

digits

(nonnegative integer) The minimum number of significant digits to print. If NULL, defaults to getOption("posterior.digits", 2).

max_iterations

(positive integer) The maximum number of iterations to print. Can be controlled globally via the "posterior.max_iterations" option.

max_chains

(positive integer) The maximum number of chains to print. Can be controlled globally via the "posterior.max_chains" option.

max_variables

(positive integer) The maximum number of variables to print. Can be controlled globally via the "posterior.max_variables" option.

reserved

(logical) Should reserved variables be included in the output? Defaults to FALSE. See reserved_variables for an overview of currently reserved variable names.

...

Further arguments passed to the underlying print() methods.

Value

A draws object of the same class as x.

Examples

x <- as_draws_array(example_draws())
print(x)


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