transitionProbabilities: Return all transition probabilities of the pension table (generational probabilities)

Description

Return all transition probabilities of the pension table (generational probabilities)

Usage

transitionProbabilities(object, ...)
# S4 method for pensionTable
transitionProbabilities(
  object,
  YOB = 1982,
  ...,
  ages = NULL,
  OverallMortality = FALSE,
  Period = NULL,
  retirement = NULL,
  invalids.retire = object@invalids.retire,
  as.data.frame = TRUE
)

Arguments

object

A pension table object (instance of a pensionTable class)

...

Currently unused

YOB

Year of birth

ages

Desired age range (if NULL, the probabilities of the age range provided by the table will be returned), missing ages will be filled with NA

OverallMortality

Whether the overall mortality should be returned for actives, or the active mortality

Period

Observation year to calculate period transition probabilities. If given, this arguments overrides the YOB parameter and this function returns period transition probabilities. If this argument is not given or is null, then this function returns generational transition probabilities.

retirement

Override the retirement transition probabilities of the pension table. Possible values are:

Single age (describing a deterministric retirement at the given age)
mortalityTable object: transition probabilities for retirement

invalids.retire

Override the pensionTable's invalids.retire flag, which indicates whether invalids retire like actives (i.e. same death probabilities after retirement) or stay invalid until death.

as.data.frame

Whether the return value should be a data.frame or an array containing transition matrices

Methods (by class)

transitionProbabilities(pensionTable): Return all transition probabilities of the pension table for the generation YOB

Examples

Run this code

pensionTables.load("USA_PensionPlans")
transitionProbabilities(RP2014.male, YOB = 1962)
transitionProbabilities(RP2014.male, Period = 1955)
transitionProbabilities(RP2014.male, Period = 2025)

Run the code above in your browser using DataLab