summarymethods {rstan}  R Documentation 
Summary method for stanfit objects
Description
Summarize the distributions of estimated parameters and derived quantities using the posterior draws.
Usage
## S4 method for signature 'stanfit'
summary(object, pars, probs = c(0.025, 0.25, 0.50, 0.75, 0.975),
use_cache = TRUE, ...)
Arguments
object 
An instance of class 
pars 
A character vector of parameter names. Defaults to all parameters
as well as the logposterior ( 
probs 
A numeric vector of 
use_cache 
Logical, defaulting to 
... 
Currently unused. 
Value
The summary
method returns a named list with elements summary
and c_summary
, which contain summaries for for all chains merged and
individual chains, respectively.
Included in the summaries are quantiles, means, standard deviations (sd),
effective sample sizes (n_eff), and split Rhats (the potential scale
reduction derived from all chains after splitting each chain in half and
treating the halves as chains). For the summary of all chains merged,
Monte Carlo standard errors (se_mean) are also reported.
See Also

monitor
, which computes similar summaries but accepts an array of MCMC draws as its input rather than astanfit
object. The RStan vignettes for more example usage.
Examples
## Not run:
ecode < '
parameters {
array[2] real<lower=0> y;
}
model {
y ~ exponential(1);
}
'
fit < stan(model_code = ecode)
s < summary(fit, probs = c(0.1, 0.9))
s$summary # all chaines merged
s$c_summary # individual chains
## End(Not run)