prior_summary: Generic function for extracting information about prior...

Description Usage Arguments Value See Also Examples

View source: R/prior_summary.R

Description

See prior_summary.stanreg in the rstanarm package for an example.

Usage

1
2
3
4
prior_summary(object, ...)

## Default S3 method:
prior_summary(object, ...)

Arguments

object

The object to use.

...

Arguments passed to methods. See the methods in the rstanarm package for examples.

Value

prior_summary methods should return an object containing information about the prior distribution(s) used for the given model. The structure of this object will depend on the method.

The default method just returns object$prior.info, which is NULL if there is no 'prior.info' element.

See Also

Examples

1
# See help("prior_summary", package = "rstanarm")

stan-dev/rstantools documentation built on May 26, 2018, 8:25 p.m.