# A Framework for Various Types of Mortality / Life Tables

## Documentation for package ‘MortalityTables’ version 2.0.5

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D F G L M P S T U W

MortalityTables-package | Provide life table classes for life insurance purposes

## -- A --

ages | Return the defined ages of the life table
ages-method | Return the defined ages of the life table
ageShift | Return the age shift of the age-shifted life table given the birth year
ageShift-method | Return the age shift of the age-shifted life table given the birth year

## -- B --

baseTable | Return the base table of the life table
baseTable-method | Return the base table of the life table
baseYear | Return the base year of the life table
baseYear-method | Return the base year of the life table

## -- C --

calculateImprovements | Calculate the improvement factors for the given birth-year and the 'mortalityTable.improvementFactors' object
calculateImprovements-method | Calculate the improvement factors for the given birth-year and the 'mortalityTable.improvementFactors' object
commutationNumbers | Calculate the commutation numbers for the given parameters, using the mortality table and an interest rate
commutationNumbers-method | Calculate the commutation numbers for the given parameters, using the mortality table and an interest rate

## -- D --

deathProbabilities | Return the (cohort) death probabilities of the life table given the birth year (if needed)
deathProbabilities-method | Return the (cohort) death probabilities of the life table given the birth year (if needed)
deathProbabilitiesIndividual | Return a matrix of the persons' individual death probabilities of a joint-life table (instance of 'mortalityTable.jointLives')

## -- F --

fillAges | Fill the given probabilities with NA to match the desired age range.
fitExpExtrapolation | Fit an exponential function exp(-A*(x-x0)) to the last value (f(100) and f'(100) need to coincide):

## -- G --

generateAgeShift | Generate data.frame containing age shifts for each birth year
getCohortTable | Return the cohort life table as a 'mortalityTable.period' object
getCohortTable-method | Return the cohort life table as a 'mortalityTable.period' object
getOmega | Return the maximum age of the life table
getOmega-method | Return the maximum age of the life table
getPeriodTable | Return the period life table as a 'mortalityTable.period' object
getPeriodTable-method | Return the period life table as a 'mortalityTable.period' object

## -- L --

lifeTable | Return the lifetable object (package lifecontingencies) for the cohort life table
lifeTable-method | Return the lifetable object (package lifecontingencies) for the cohort life table

## -- M --

makeQxDataFrame | Converts one or multiple mortality table objects to a data frame that can be plotted by 'plotMortalityTables' or 'plotMortalityTableComparisons'
mortalityComparisonTable | Calculate relative mortalities for age bands and birth years
mortalityImprovement | Return the mortality trend (yearly log-death-probability improvement) of the given period or the given generation.
mortalityImprovement-method | Return the mortality trend (yearly log-death-probability improvement) of the given period or the given generation.
mortalityTable | Class mortalityTable
mortalityTable-class | Class mortalityTable
mortalityTable.ageShift | Class mortalityTable.ageShift - Cohort life tables generated by age-shift
mortalityTable.ageShift-class | Class mortalityTable.ageShift - Cohort life tables generated by age-shift
mortalityTable.deMoivre | Class mortalityTable.deMoivre - Mortality table with de Moivre's law
mortalityTable.deMoivre-class | Class mortalityTable.deMoivre - Mortality table with de Moivre's law
mortalityTable.improvementFactors | Class mortalityTable.improvementFactors - Cohort life table with improvement factors
mortalityTable.improvementFactors-class | Class mortalityTable.improvementFactors - Cohort life table with improvement factors
mortalityTable.jointLives | Class mortalityTable.jointLives - Life table for multiple joint lives
mortalityTable.jointLives-class | Class mortalityTable.jointLives - Life table for multiple joint lives
mortalityTable.MakehamGompertz | Class mortalityTable.MakehamGompertz - Mortality table with Makeham-Gompertz's law
mortalityTable.MakehamGompertz-class | Class mortalityTable.MakehamGompertz - Mortality table with Makeham-Gompertz's law
mortalityTable.mixed | Class mortalityTable.mixed - Life table as a mix of two life tables
mortalityTable.mixed-class | Class mortalityTable.mixed - Life table as a mix of two life tables
mortalityTable.NA | Empty mortality table indicating NA
mortalityTable.observed | Class mortalityTable.observed - Life table from actual observations
mortalityTable.observed-class | Class mortalityTable.observed - Life table from actual observations
mortalityTable.once | Generate a (deterministic) mortality table with only one probability set to 1 (for the given age)
mortalityTable.onceAndFuture | Generate a (deterministic) mortality table with all probabilities starting at a given age set to 1
mortalityTable.period | Class mortalityTable.period - Period life tables
mortalityTable.period-class | Class mortalityTable.period - Period life tables
mortalityTable.trendProjection | Class mortalityTable.trendProjection - Cohort mortality table with age-specific trend
mortalityTable.trendProjection-class | Class mortalityTable.trendProjection - Cohort mortality table with age-specific trend
mortalityTable.Weibull | Class mortalityTable.Weibull - Mortality table with Weibull's law
mortalityTable.Weibull-class | Class mortalityTable.Weibull - Mortality table with Weibull's law
mortalityTable.zeroes | Generate a mortality table with all probabilities set to zero.
MortalityTables | Provide life table classes for life insurance purposes
mortalityTables.list | List all available sets of life tables provided by the MortalityTables-package package An existing life table can then be loaded with mortalityTables.load.
mortalityTables.load | Load a named set of mortality tables provided by the MortalityTables package
mT.addTrend | Set/Add a trend vector for the probabilities of the given 'mortalityTable' object(s). Returns a 'mortalityTable.trendProjection' object
mT.cleanup | Remove all non-essential data (raw data, etc.) from a mortalityTable object
mT.cleanup-method | Remove all non-essential data (raw data, etc.) from a mortalityTable object
mT.extrapolateProbsExp | Extrapolate base table of a mortalityTable using an exponential function
mT.extrapolateTrendExp | Extrapolate a mortality trend exponentially
mT.fillAges | Restrict/expand a mortalityTable to certain ages
mT.fitExtrapolationLaw | Fit interpolation law to a mortality table and extrapolate
mT.round | Round all components of a mortality table to the given number of digits
mT.round-method | Round all components of a mortality table to the given number of digits
mT.scaleProbs | Scale all probabilities of the given 'mortalityTable' object(s) by the given factor
mT.setDimInfo | Set additional information (year, description, type of risk, sex, etc.) for the mortality table.
mT.setName | Sets a new name for the given mortality table or the list/table/array of mortalityTables
mT.setTrend | Set/Add a trend vector for the probabilities of the given 'mortalityTable' object(s). Returns a 'mortalityTable.trendProjection' object
mT.switchover | Switch over mortalities from one table to another at a given age
mT.translate | Translate base table of a cohort mortality table to a different observation year

## -- P --

pensionTable | Class pensionTable
pensionTable-class | Class pensionTable
pensionTables.list | List all available sets of pension tables provided by the MortalityTables-package package An existing pension table can then be loaded with pensionTables.load.
pensionTables.load | Load a named set of pension tables provided by the MortalityTables package
periodDeathProbabilities | Return the (period) death probabilities of the life table for a given observation year
periodDeathProbabilities-method | Return the (period) death probabilities of the life table for a given observation year
periodDeathProbabilitiesIndividual | Return a matrix of the persons' individual period death probabilities of a joint-life table (instance of 'mortalityTable.jointLives')
periodTransitionProbabilities | Return all period transition probabilities of the pension table
periodTransitionProbabilities-method | Return all period transition probabilities of the pension table
plot.mortalityTable | Plot multiple mortality tables (life tables) in one plot
plotMortalityTableComparisons | Plot multiple mortality tables (life tables) in one plot, relative to a given reference table
plotMortalityTables | Plot multiple mortality tables (life tables) in one plot
plotMortalityTrend | Plot the trends of multiple mortality tables (life tables) in one chart
PopulationData.AT2017 | Austrian population count (exposure) and deaths in 2017
pT.calculateTotalMortality | Calculate the total mortality of the pension table
pT.getSubTable | Extract a sub-table from a pensionTable
pT.recalculateTotalMortality | Calculate the total mortality of the pension table
pT.setDimInfo | Set additional information (year, description, type of risk, sex, etc.) for the pension table.

## -- S --

setLoading | Return a copy of the table with an additional loading added
setLoading-method | Return a copy of the table with an additional loading added
setModification | Return a copy of the table with the given modification function added
setModification-method | Return a copy of the table with the given modification function added

## -- T --

transitionProbabilities | Return all transition probabilities of the pension table (generational probabilities)
transitionProbabilities-method | Return all transition probabilities of the pension table (generational probabilities)

## -- U --

undampenTrend | Return a 'mortalityTable.trendProjection' object with the trend damping removed.
undampenTrend-method | Return a 'mortalityTable.trendProjection' object with the trend damping removed.

## -- W --

whittaker.mortalityTable | Smooth a life table using the Whittaker-Henderson method, intepolation possibly missing values