prior_summary.epimodel: Returns a summary of the prior distributions used

Description Usage Arguments Value

View source: R/prior_summary.R

Description

Returns a summary of the prior distributions used

Usage

1
2
## S3 method for class 'epimodel'
prior_summary(object, digits = 3, ...)

Arguments

object

The object to use.

digits

Number of digits used for rounding.

...

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.


epidemia documentation built on Oct. 25, 2021, 9:09 a.m.