summary.stapDP: Summary method for stapDP objects

View source: R/print-summary.R

summary.stapDPR Documentation

Summary method for stapDP objects

Description

Summaries of parameter estimates and MCMC convergence diagnostics (effective sample size, Rhat).

Usage

## S3 method for class 'stapDP'
summary(object, ..., digits = 1)

## S3 method for class 'summary.stapDP'
print(x, digits = max(1, attr(x, "print.digits")), ...)

Arguments

object

stapDP object

...

ignored

digits

Number of digits to use for formatting numbers when printing. When calling summary, the value of digits is stored as the "print.digits" attribute of the returned object.

x

An object of class "summary.stapDP".

Value

The summary method returns an object of class "summary.staDP" which is a matrix of summary statistics and diagnostics, with attributes storing information for use by the print method.


apeterson91/rstapDP documentation built on Sept. 20, 2023, 9:34 a.m.