Skip to contents

Summarise a fit from ctFit, on either backend: population parameters with their uncertainty, random-effect spreads and correlations, time independent predictor effects, the parameter matrices, and the log likelihood and AIC.

Usage

# S3 method for class 'ctJuliaFit'
summary(
  object,
  timeinterval = 1,
  digits = 3,
  parmatrices = TRUE,
  priorcheck = TRUE,
  residualcov = TRUE,
  ...
)

# S3 method for class 'ctStanFit'
summary(
  object,
  timeinterval = 1,
  digits = 3,
  parmatrices = TRUE,
  priorcheck = TRUE,
  residualcov = TRUE,
  ...
)

Arguments

object

fit object from ctFit, of class ctStanFit or ctJuliaFit.

timeinterval

positive numeric indicating time interval to use for discrete time parameter calculations reported in summary.

digits

integer denoting number of digits to report.

parmatrices

if TRUE, also return additional parameter matrices – can be slow to compute for large models with many samples.

priorcheck

Whether or not to use priorchecking to compare posterior mean and sd to prior mean and sd. backend='stan' only: a julia fit carries no prior block to compare against, and refuses priorcheck = TRUE given explicitly.

residualcov

Whether or not to show standardised residual covariance. Takes a little longer to compute.

...

Additional arguments to pass to priorcheckreport, such as meanlim, or sdlim.

Value

List containing summary items, with a print method for readable console and knitr output. On an optimised backend = 'julia' fit with uncertainty draws, the parameter tables and parmatrices carry a mode column beside the draws' mean, sd and quantiles: the fit's estimate on the same scale, the point a likelihood ratio or an information criterion refers to.

popmeans reports each free parameter. A T0VAR, DIFFUSION or MANIFESTVAR parameter is a standard deviation on the diagonal; off it, a coordinate the model's covmattransform turns into correlations, not a correlation: under the default 'z' it is an entry of the correlation matrix's logarithm, which for two variables is the correlation's Fisher z (tanh() of it is the correlation) and for more is no function of any one correlation. The correlations are in parmatrices, as T0cor, DIFFUSIONcor, MANIFESTcor and asymDIFFUSIONcor beside the covariances, each summarised over the draws' own correlations.

Examples

summary(ctstantestfit)