residuals.fitStMoMo: Extract deviance residuals of a Stochastic Mortality Model

Description Usage Arguments Value See Also Examples

View source: R/residualsfitStMoMo.R

Description

Compute deviance residuals of a fitted Stochastic Mortality Model. These residuals can be plotted using plot.resStMoMo.

Usage

1
2
## S3 method for class 'fitStMoMo'
residuals(object, scale = TRUE, ...)

Arguments

object

an object of class "fitStMoMo" with the fitted parameters of a stochastic mortality model.

scale

logical indicating whether the residuals should be scaled or not by dividing the deviance by the overdispersion of the model. Default is TRUE.

...

other arguments.

Value

An object of class "resStMoMo" with the residuals. This object has components:

residuals

a matrix with the residuals.

ages

ages corresponding to the rows in residuals.

years

years corresponding to the columns in residuals.

See Also

plot.resStMoMo

Examples

1
2
3
CBDfit <- fit(cbd(), data = central2initial(EWMaleData), ages.fit = 55:89)
CBDres <- residuals(CBDfit)
plot(CBDres)

Example output

Loading required package: gnm
Loading required package: forecast
StMoMo: Start fitting with gnm
StMoMo: Finish fitting with gnm

StMoMo documentation built on May 2, 2019, 11:42 a.m.