Summarize the priors used in a salmonIPM model

Print a summary of the priors on hyperparameters in a fitted salmonIPMfit model object.

Usage

# S3 method for class 'salmonIPMfit'
prior_summary(object, digits = 2, ...)

Arguments

object

An object of class salmonIPMfit with prior information stored in prior.info.

digits

Number of decimal places to print.

...

Currently ignored.

Value

A character vector containing the prior summary information.

Details

This function is called mainly for its side effect of printing the prior summary. The character vector to be printed is returned invisibly, but the same information can be found in more usable form in object$prior.info. Priors are identified as user-specifiable or hard-coded in the printed output.

Note that correlation matrices are given lkj_corr priors, but the actual Stan implementation uses the more efficient lower Cholesky factor version of the LKJ distribution.

See also

prior_summary(), priors, salmonIPM(), salmonIPMfit