Print method for salmonIPMfit objects

Print information on the fitted model and a posterior summary for parameters of interest estimated by the samples included in a salmonIPMfit object.

Usage

# S3 method for class 'salmonIPMfit'
print(
  x,
  pars = "hyper",
  include = TRUE,
  probs = c(0.05, 0.5, 0.95),
  digits = 2,
  ...
)

Arguments

x

An object of class salmonIPMfit.

pars

A character vector specifying (hyper)parameters, states, and/or quantities of interest ("parameters") to summarize. Parameters can be explicitly named or one or more shortcuts can be used to specify hierarchical levels of parameters; see stan_pars() for details. The default is "hyper", i.e. the top-level hyperparameters that are given priors.

include

Logical scalar defaulting to TRUE indicating whether to include or exclude the parameters given by pars. If FALSE, only entire multidimensional parameters can be excluded, rather than particular elements of them.

probs

A numeric vector of posterior quantiles to print. The default is c(0.05, 0.5, 0.95), i.e. the median and 90% credible interval.

digits

Number of decimal places to print, defaulting to 2. Applies to quantities other than the effective sample size, which is always rounded to the nearest integer.

...

Currently ignored.

Details

If pars includes correlation matrices, only the lower triangular elements are returned. This avoids redundant summary output as well as false positive diagnostic results such as bulk-ESS and Rhat being NaN for the diagonal elements.

See also

salmonIPMfit, diagnostics

Examples

# <under construction>