summary.dc: Summarize a draws component (dc) object

In mcmcsae: Markov Chain Monte Carlo Small Area Estimation

Summarize a draws component (dc) object

Description

Summarize a draws component (dc) object

Usage

## S3 method for class 'dc'
summary(
  object,
  probs = c(0.05, 0.5, 0.95),
  na.rm = FALSE,
  time = NULL,
  abbr = FALSE,
  batch.size = 100L,
  ...
)

Arguments

object	an object of class dc.
probs	vector of probabilities at which to evaluate quantiles.
na.rm	whether to remove NA/NaN draws in computing the summaries.
time	MCMC computation time; if specified the effective sample size per unit of time is returned in an extra column labeled 'efficiency'.
abbr	if TRUE abbreviate the labels in the output.
batch.size	number of parameter columns to process simultaneously. 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 matrix with summaries of class dc_summary.

Examples

ex <- mcmcsae_example()
sampler <- create_sampler(ex$model, data=ex$dat)
sim <- MCMCsim(sampler, store.all=TRUE)
summary(sim$u)

mcmcsae documentation built on Oct. 11, 2023, 1:06 a.m.