periodDeathProbabilities: Return the (period) death probabilities of the life table for...

periodDeathProbabilitiesR Documentation

Return the (period) death probabilities of the life table for a given observation year

Description

Return the (period) death probabilities of the life table for a given observation year

Usage

periodDeathProbabilities(object, ..., ages = NULL, Period = 1975)

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

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

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

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

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

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

## S4 method for signature 'mortalityTable.observed'
periodDeathProbabilities(object, ..., ages = NULL, Period = 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

Period

The observation year for which the period death probabilities should be determined

ageDifferences

A vector of age differences of all joint lives.

Methods (by class)

  • periodDeathProbabilities(mortalityTable.period): Return the (period) death probabilities of the life table for a given observation year

  • periodDeathProbabilities(mortalityTable.ageShift): Return the (period) death probabilities of the life table for a given observation year

  • periodDeathProbabilities(mortalityTable.trendProjection): Return the (period) death probabilities of the life table for a given observation year

  • periodDeathProbabilities(mortalityTable.improvementFactors): Return the (period) death probabilities of the life table for a given observation year

  • periodDeathProbabilities(mortalityTable.mixed): Return the (period) death probabilities of the life table for a given observation year

  • periodDeathProbabilities(mortalityTable.jointLives): Return the (period) death probabilities of the joint lives mortality table for a given observation year

  • periodDeathProbabilities(mortalityTable.observed): Return the (period) death probabilities of the life table for a given observation year If the observed mortality table does not provide data for the desired period, the period closest to the 'Period' argument will be used and a warning printed.

Examples

mortalityTables.load("Austria_Annuities")
periodDeathProbabilities(AVOe2005R.male, Period = 1975)
periodDeathProbabilities(AVOe2005R.male, Period = 2017)

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


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