summary.sstapreg: Summary method for sstapreg objects

Description Usage Arguments Value

View source: R/print-and-summary.R

Description

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

Usage

1
2
3
4
5
## S3 method for class 'sstapreg'
summary(object, probs = c(0.05, 0.5, 0.95), ..., digits = 1)

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

Arguments

object

sstapreg object

probs

an optional numeric vector of probabilities pased to quantile

...

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.sstapreg".

Value

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


apeterson91/rsstap documentation built on April 7, 2021, 4:36 p.m.