prior_summary

0th

Percentile

Generic function for extracting information about prior distributions

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

Usage
prior_summary(object, ...)

# S3 method for default 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

  • Guidelines and recommendations for developers of R packages interfacing with Stan and a demonstration getting a simple package working can be found in the vignettes included with rstantools and at mc-stan.org/rstantools/articles.

Aliases
  • prior_summary
  • prior_summary.default
Examples
# NOT RUN {
# See help("prior_summary", package = "rstanarm")

# }
Documentation reproduced from package rstantools, version 2.1.1, License: GPL (>= 3)

Community examples

Looks like there are no examples yet.