coef.fitStMoMo: Extract coefficients from a fitted Stochastic Mortality Model

Description Usage Arguments Value Examples

View source: R/coeffitStMoMo.R

Description

Extract coefficients from a fitted Stochastic Mortality Model

Usage

1
2
## S3 method for class 'fitStMoMo'
coef(object, ...)

Arguments

object

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

...

other arguments.

Value

A list of model parameters with components:

ax

Vector with the fitted values of the static age function α_x. If the model does not have a static age function or failed to fit this is set to NULL.

bx

Matrix with the values of the period age-modulating functions β_x^{(i)}, i=1, ..., N. If the i-th age-modulating function is non-parametric (e.g., as in the Lee-Carter model) bx[, i] contains the estimated values. If the model does not have any age-period terms (i.e. N=0) or failed to fit this is set to NULL.

kt

Matrix with the values of the fitted period indexes κ_t^{(i)}, i=1, ..., N. kt[i, ] contains the estimated values of the i-th period index. If the model does not have any age-period terms (i.e. N=0) or failed to fit this is set to NULL.

b0x

Vector with the values of the cohort age-modulating function β_x^{(0)}. If the age-modulating function is non-parametric b0x contains the estimated values. If the model does not have a cohort effect or failed to fit this is set to NULL.

gc

Vector with the fitted cohort index γ_{c}. If the model does not have a cohort effect or failed to fit this is set to NULL.

Examples

1
2
APCfit <- fit(apc(), data = EWMaleData)
coef(APCfit) 

amvillegas/StMoMo documentation built on Nov. 7, 2019, 5:39 a.m.