mcmcsae (version 0.6.0)

summary.draws: Summarize a draws object

Description

Summarize a draws object

Usage

# S3 method for draws
summary(
  object,
  vnames = NULL,
  probs = c(0.05, 0.5, 0.95),
  na.rm = FALSE,
  efficiency = FALSE,
  abbr = FALSE,
  batch.size = 100L,
  ...
)

Arguments

object

an object of class draws.

vnames

optional character vector to select a subset of parameters.

probs

vector of probabilities at which to evaluate quantiles.

na.rm

whether to remove NA/NaN draws in computing the summaries.

efficiency

if TRUE the effective sample size per second of computation time is returned as well.

abbr

if TRUE abbreviate the labels in the output.

batch.size

number of parameter columns to process simultaneously for vector parameters. A larger batch size may speed things up a little, but if an out of memory error occurs it may be a good idea to use a smaller number and try again. The default is 100.

...

arguments passed to n_eff.

Value

A list of class draws_summary summarizing object.

Examples

# NOT RUN {
ex <- mcmcsae_example()
sampler <- create_sampler(ex$model, data=ex$dat)
sim <- MCMCsim(sampler, store.all=TRUE)
summary(sim)
par_names(sim)
summary(sim, c("beta", "v_sigma", "u_sigma"))
# }
# NOT RUN {
# }