print.draws_rvars {posterior} | R Documentation |
Print draws_rvars
objects
Description
Pretty printing for draws_rvars
objects.
Usage
## S3 method for class 'draws_rvars'
print(
x,
digits = 2,
max_variables = getOption("posterior.max_variables", 8),
summary = getOption("posterior.rvar_summary", "mean_sd"),
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_variables |
(positive integer) The maximum number of variables to
print. Can be controlled globally via the "posterior.max_variables"
option.
|
summary |
(string) The style of summary to display:
-
"mean_sd" displays mean ± sd
-
"median_mad" displays median ± mad
-
"mode_entropy" displays mode <entropy> , and is used automatically for
rvar_factor s. It shows normalized entropy, which ranges from
0 (all probability in one category) to 1 (uniform). See entropy() .
-
"mode_dissent" displays mode <dissent> , and is used automatically for
rvar_ordered s. It shows Tastle and Wierman's (2007) dissention
measure, which ranges from 0 (all probability in one category) through
0.5 (uniform) to 1 (bimodal: all probability split equally between the
first and last category). See dissent() .
-
NULL uses getOption("posterior.rvar_summary") (default "mean_sd )
|
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_rvars(example_draws())
print(x)
[Package
posterior version 1.4.1
Index]