Skip to contents

This function returns summary statistics for PMMH output objects, including means, standard deviations, medians, credible intervals, and diagnostics.

Usage

# S3 method for class 'pmmh_output'
summary(object, ...)

Arguments

object

An object of class `pmmh_output`.

...

Additional arguments.

Value

A data frame containing summary statistics for each parameter.

Examples

# Create dummy chains for two parameters across two chains
chain1 <- data.frame(param1 = rnorm(100), param2 = rnorm(100), chain = 1)
chain2 <- data.frame(param1 = rnorm(100), param2 = rnorm(100), chain = 2)
dummy_output <- list(
  theta_chain = rbind(chain1, chain2),
  diagnostics = list(
    ess = c(param1 = 200, param2 = 190),
    rhat = c(param1 = 1.01, param2 = 1.00)
  )
)
class(dummy_output) <- "pmmh_output"
summary(dummy_output)
#>               mean        sd      median      2.5%    97.5% ESS Rhat
#> param1  0.03028700 1.1791722 -0.08151270 -2.406859 2.344359 200 1.01
#> param2 -0.05183869 0.9637325 -0.03151819 -1.980977 1.798555 190 1.00