Skip to contents

Summary Method for JuliaBUGS Sampler Output

Source: R/summary.R
summary.rjuliabugs.Rd

Provides a summary of the results from a JuliaBUGS sampler object, including Markov Chain Monte Carlo (MCMC) settings, summary statistics, and optionally quantiles.

Usage

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

Arguments

object

An object of class rjuliabugs containing a reference to a Markov Chain Monte Carlo (MCMC) sampler from Julia.

...

Additional optional arguments. Supported options:

  • digits: Integer. Number of significant digits to display. Default: 4.

  • n_display: Integer. Number of rows of summary statistics to show. Default: 10.

  • get_summary: Logical. If TRUE, returns summary statistics in the output list. Default: FALSE.

  • get_quantiles: Logical. If TRUE, returns quantiles in the output list. Default: FALSE.

  • julia_summary_only: Logical. If TRUE, displays the Julia summary directly and returns NULL invisibly. Default: FALSE.

Value

If julia_summary_only = TRUE, no value is called for the print message. Otherwise, returns a list possibly containing:

  • summary: Data frame of summary statistics (if get_summary = TRUE).

  • quantiles: Data frame of quantiles (if get_quantiles = TRUE).

Details

This method wraps Julia's MCMCChains.summarystats and MCMCChains.quantile to extract and display results in R using the JuliaCall interface. It also extracts key MCMC settings like number of chains, iterations, and samples per chain. The printed summary is truncated to n_display rows.