Add class to handle pension tables (first attempt, not finished yet)

man/mortalityTable.period-class.Rd

@@ -2,8 +2,8 @@
 % Please edit documentation in R/mortalityTable.period.R
 \docType{class}
 \name{mortalityTable.period-class}
-\alias{mortalityTable.period}
 \alias{mortalityTable.period-class}
+\alias{mortalityTable.period}
 \title{Class mortalityTable.period - Period life tables}
 \description{
 A period life table, giving death probabilities for each age, up to

man/mortalityTable.trendProjection-class.Rd

@@ -2,8 +2,8 @@
 % Please edit documentation in R/mortalityTable.trendProjection.R
 \docType{class}
 \name{mortalityTable.trendProjection-class}
-\alias{mortalityTable.trendProjection}
 \alias{mortalityTable.trendProjection-class}
+\alias{mortalityTable.trendProjection}
 \title{Class mortalityTable.trendProjection - Cohort mortality table with age-specific trend}
 \description{
 A cohort mortality table, obtained by a trend projection from a given base table

man/mortalityTables.list.Rd

@@ -17,4 +17,3 @@ directory. Defaults to the "MortalityTables" package.}
 List all available sets of life tables provided by the \link[MortalityTables]{MortalityTables-package} package
 An existing life table can then be loaded with \link{mortalityTables.load}.
 }
-

man/mortalityTables.load.Rd

@@ -19,4 +19,3 @@ directory. Defaults to the "MortalityTables" package.}
 \description{
 Load a named set of mortality tables provided by the \link{MortalityTables} package
 }
-

man/pensionTable-class.Rd

+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/pensionTable.R
+\docType{class}
+\name{pensionTable-class}
+\alias{pensionTable-class}
+\alias{pensionTable}
+\title{Class pensionTable}
+\description{
+Class \code{pensionTable} is the (virtual) base class for all pensions
+tables. It contains the name and some general values applying to all
+types of tables. In particular, it holds individual tables for each of the
+transition probabilities. Possible states are:
+    * active: healty, no pension, typically paying some kin of premium
+    * incapacity: disablity pension, in most cases permanent, not working, early pension
+    * retirement: old age pension, usually starting with a fixed age
+    * dead
+      * Widow/widower pension
+}
+\details{
+Correspondingly, the following transition probabilities can be given:
+    * qxaa:  death probability of actives (active -> dead)
+    * ix:    invalidity probability (active -> incapacity)
+    * qxi:   death probability of invaid (invalid -> dead)
+    * rx:    reactivation probability (incapacity -> active)
+    * apx:   retirement probability (active -> retirement), typically 1 for a fixed age
+    * apx:   retirement probability of invalids (invalid -> retirement), typically 0 or 1 for a fixed age
+    * qxApm: death probability of retired (retired -> dead)
+    * hx:    probability of a widow at moment of death (dead -> widow), y(x) age differene
+    * qxw:   death probability of widows/widowers
+}
+\section{Slots}{
+
+\describe{
+\item{\code{qx}}{Death probability table of actives (derived from mortalityTable)}
+
+\item{\code{ix}}{Invalidity probability of actives (derived from mortalityTable)}
+
+\item{\code{qxi}}{Death probability table of invalids (derived from mortalityTable)}
+
+\item{\code{rx}}{Reactivation probability of invalids (derived from mortalityTable)}
+
+\item{\code{apx}}{Retirement probability of actives (derived from mortalityTable)}
+
+\item{\code{apxi}}{Retirement probability of invalids (derived from mortalityTable)}
+
+\item{\code{qxApm}}{Death probability of old age pensioners (derived from mortalityTable)}
+
+\item{\code{hx}}{Probability of a widow at the moment of death (derived from mortalityTable)}
+
+\item{\code{qxw}}{Death probability of widow(er)s (derived from mortality Table)}
+
+\item{\code{xy}}{Age difference of the widow to the deceased}
+}}
+

man/periodDeathProbabilities.Rd

 % Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/periodDeathProbabilities.R, R/mortalityTable.jointLives.R
+% Please edit documentation in R/periodDeathProbabilities.R,
+%   R/mortalityTable.jointLives.R
 \docType{methods}
 \name{periodDeathProbabilities}
 \alias{periodDeathProbabilities}
+\alias{periodDeathProbabilities,mortalityTable.period-method}
 \alias{periodDeathProbabilities,mortalityTable.ageShift-method}
+\alias{periodDeathProbabilities,mortalityTable.trendProjection-method}
 \alias{periodDeathProbabilities,mortalityTable.improvementFactors-method}
-\alias{periodDeathProbabilities,mortalityTable.jointLives-method}
 \alias{periodDeathProbabilities,mortalityTable.mixed-method}
-\alias{periodDeathProbabilities,mortalityTable.period-method}
-\alias{periodDeathProbabilities,mortalityTable.trendProjection-method}
+\alias{periodDeathProbabilities,mortalityTable.jointLives-method}
 \title{Return the (period) death probabilities of the life table for a given
 observation year}
 \usage{

man/plot.mortalityTable.Rd

@@ -65,4 +65,3 @@ plot(mort.AT.census.1869.male, mort.AT.census.1869.female,
 \seealso{
 \code{\link{plotMortalityTables}} and \code{\link{plotMortalityTableComparisons}}
 }
-

man/plotMortalityTableComparisons.Rd

@@ -32,4 +32,3 @@ plotMortalityTableComparisons(data, ..., xlim = NULL, ylim = NULL,
 \description{
 \code{plotMortalityTableComparisons} prints multiple life tables (objects of child classes of \code{mortalityTable}) in one plot and scales each by the given reference table, so that the relative mortality can be easily seen. A legend is added showing the names of the tables.
 }
-

man/plotMortalityTables.Rd

@@ -30,4 +30,3 @@ plotMortalityTables(data, ..., xlim = NULL, ylim = NULL, xlab = NULL,
 \description{
 \code{plotMortalityTables} prints multiple life tables (objects of child classes of \code{mortalityTable}) in one log-linear plot, with a legend showing the names of the tables.
 }
-