SummaryResults-class: S4 class summarizing results from estimation or prediction.

In StatisticsNZ/demest: Bayesian Demographic Estimation and Forecasting

S4 class summarizing results from estimation or prediction.

Description

SummaryResults is the superclass for classes holding results from functions estimateModel, estimateCounts, estimateAccount, predictModel, predictCounts, and predictAccount (though the summaries from the predict functions are generally less informative.)

Usage

## S4 method for signature 'SummaryModel'
show(object)

## S4 method for signature 'SummaryDataset'
show(object)

## S4 method for signature 'SummarySeries'
show(object)

## S4 method for signature 'SummaryResultsModelEst'
show(object)

## S4 method for signature 'SummaryResultsModelPred'
show(object)

## S4 method for signature 'SummaryResultsCounts'
show(object)

## S4 method for signature 'SummaryResultsAccount'
show(object)

Arguments

object

Object of class SummaryResults.

Details

Objects of class SummaryResults are created using function fetchSummary. Individual components from summary objects can be extracted using functions gelmanDiag, metropolis, and parameters.

Slots

mcmc

named integer vector containing nBurnin, nSim, nChain, nThin, nIteration

parameters

data.frame summarizing parameter estimates.

StatisticsNZ/demest documentation built on Nov. 2, 2023, 7:56 p.m.