summary.simmr_output_tdf: Summarises the output created with 'simmr_mcmc_tdf'

Description Usage Arguments Details Value Author(s) See Also

View source: R/summary.simmr_output_tdf.R

Description

Produces textual summaries and convergence diagnostics for an object created with simmr_mcmc_tdf. The different options are: 'diagnostics' which produces Brooks-Gelman-Rubin diagnostics to assess MCMC convergence, 'quantiles' which produces credible intervals for the parameters, 'statistics' which produces means and standard deviations, and 'correlations' which produces correlations between the parameters.

Usage

1
2
3
4
5
6
## S3 method for class 'simmr_output_tdf'
summary(
  object,
  type = c("diagnostics", "quantiles", "statistics", "correlations"),
  ...
)

Arguments

object

An object of class simmr_output_df produced by the function simmr_mcmc_tdf

type

The type of output required. At least none of 'diagnostics', 'quantiles', 'statistics', 'correlations'

...

Not used

Details

The quantile output allows easy calculation of 95 per cent credible intervals of the posterior dietary proportions. The Gelman diagnostic values should be close to 1 to ensure satisfactory convergence.

Multiple groups are not currently supported for estimating TDFs.

Value

An list containing the following components:

gelman

The convergence diagnostics

quantiles

The quantiles of each parameter from the posterior distribution

statistics

The means and standard deviations of each parameter

correlations

The posterior correlations between the parameters

Note that this object is reported silently so will be discarded unless the function is called with an object as in the example below.

Author(s)

Andrew Parnell <andrew.parnell@mu.ie>

See Also

See simmr_mcmc_tdf for creating objects suitable for this function, and many more examples. See also simmr_load for creating simmr objects, plot.simmr_input for creating isospace plots, plot.simmr_output for plotting output.


simmr documentation built on Feb. 27, 2021, 5:05 p.m.