rstan (version 2.8.2)

print: Print a summary for a fitted model represented by a stanfit object

Description

Print basic information regarding the fitted model and a summary for the parameters of interest estimated by the samples included in a stanfit object.

Usage

## S3 method for class 'stanfit':
print(x, pars = x@sim$pars_oi, 
      probs = c(0.025, 0.25, 0.5, 0.75, 0.975),
      digits_summary = 2, include = TRUE, ...)

Arguments

x

An object of S4 class stanfit.

pars

Parameters in which the summaries are interest; defaults to all parameters for which samples are saved. If include = FALSE, then the specified parameters are excluded from the printed summary.

probs

Quantiles of interest; defaults to "c(0.025,0.25,0.5,0.75,0.975)"

digits_summary

The number of significant digits for printing out the summary; defaults to 1. The effective sample size is always rounded to integers.

include

Logical scalar (defaulting to TRUE) that indicates whether to include or exclude the parameters named by the pars argument

...

Additional arguments that would be passed to method summary of stanfit.

Details

The information regarding the fitted model includes the number of iterations, the number of chains, the number of iterations that are saved in the stanfit object (including warmup); which sampler of NUTS1, NUTS2, HMC is used; and when the sampling is finished.

The summary about parameters includes the mean, the standard error of the mean (se_mean), the standard deviation (sd), quantiles, the effective sample size (n_eff), and the split Rhat. The summary is computed based on merging samples without warmup iterations from all chains.

In addition to parameters, the log-posterior (lp__) is also treated like a parameter in the printout.

See Also

S4 class stanfit and particularly its method summary, which is used to obtain the values that are printed out.