deathProbabilities: Return the (cohort) death probabilities of the life table...

deathProbabilitiesR Documentation

Return the (cohort) death probabilities of the life table given the birth year (if needed)

Description

Return the (cohort) death probabilities of the life table given the birth year (if needed)

Usage

deathProbabilities(object, ..., ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.period'
deathProbabilities(object, ..., ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.ageShift'
deathProbabilities(object, ..., ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.trendProjection'
deathProbabilities(object, ..., ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.improvementFactors'
deathProbabilities(object, ..., ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.mixed'
deathProbabilities(object, ..., ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.jointLives'
deathProbabilities(object, ..., ageDifferences = c(), ages = NULL, YOB = 1975)

## S4 method for signature 'mortalityTable.observed'
deathProbabilities(object, ..., ages = NULL, YOB = 1975)

Arguments

object

The life table object (class inherited from mortalityTable)

...

Other parameters (currently unused)

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

YOB

The birth year for which the death probabilities should be calculated

ageDifferences

A vector of age differences of all joint lives.

Methods (by class)

  • deathProbabilities(mortalityTable.period): Return the (cohort) death probabilities of the life table given the birth year (if needed)

  • deathProbabilities(mortalityTable.ageShift): Return the (cohort) death probabilities of the life table given the birth year (if needed)

  • deathProbabilities(mortalityTable.trendProjection): Return the (cohort) death probabilities of the life table given the birth year (if needed)

  • deathProbabilities(mortalityTable.improvementFactors): Return the (cohort) death probabilities of the life table given the birth year (if needed)

  • deathProbabilities(mortalityTable.mixed): Return the (cohort) death probabilities of the life table given the birth year (if needed)

  • deathProbabilities(mortalityTable.jointLives): Return the (cohort) death probabilities of the life table given the birth year (if needed)

  • deathProbabilities(mortalityTable.observed): Return the (cohort) death probabilities of the life table given the birth year (if needed)

Examples

mortalityTables.load("Austria_Annuities")
deathProbabilities(AVOe2005R.male, YOB = 1975)
deathProbabilities(AVOe2005R.male, YOB = 2017)

mortalityTables.load("Germany_Census")
table.JL = mortalityTable.jointLives(
    name = "ADSt 24/26 auf verbundene Leben",
    table = mort.DE.census.1924.26.male
)
deathProbabilities(table.JL, YOB = 1977, ageDifferences = c(1, 5, -5, 16))
deathProbabilities(table.JL, YOB = 1977, ageDifferences = c(0))
deathProbabilities(table.JL, YOB = 1977, ageDifferences = c(1, 5, 16))


MortalityTables documentation built on Nov. 2, 2023, 5:52 p.m.