Skip to content
Snippets Groups Projects
Commit 92c1602f authored by Reinhold Kainhofer's avatar Reinhold Kainhofer
Browse files

Fix docstring (lists)

parent 2e9e7333
No related branches found
No related tags found
No related merge requests found
...@@ -8,23 +8,26 @@ NULL ...@@ -8,23 +8,26 @@ NULL
#' tables. It contains the name and some general values applying to all #' 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 #' types of tables. In particular, it holds individual tables for each of the
#' transition probabilities. Possible states are: #' transition probabilities. Possible states are:
#' * active: healty, no pension, typically paying some kin of premium #' \itemize{
#' * incapacity: disablity pension, in most cases permanent, not working, early pension #' \item active: healty, no pension, typically paying some kin of premium
#' * retirement: old age pension, usually starting with a fixed age #' \item incapacity: disablity pension, in most cases permanent, not working, early pension
#' * dead #' \item retirement: old age pension, usually starting with a fixed age
#' * Widow/widower pension #' \item dead \itemize{
#' #' \item Widow/widower pension
#' Correspondingly, the following transition probabilities can be given: #' }
#' * qxaa: death probability of actives (active -> dead) #' }
#' * ix: invalidity probability (active -> incapacity) #' Correspondingly, the following transition probabilities can be given:\describe{
#' * qix: death probability of invalid (invalid -> dead) #' \item{qxaa}{death probability of actives (active -> dead)}
#' * rx: reactivation probability (incapacity -> active) #' \item{ix}{invalidity probability (active -> incapacity)}
#' * apx: retirement probability (active -> retirement), typically 1 for a fixed age #' \item{qix}{death probability of invalid (invalid -> dead)}
#' * apx: retirement probability of invalids (invalid -> retirement), typically 0 or 1 for a fixed age #' \item{rx}{reactivation probability (incapacity -> active)}
#' * qpx: death probability of retired (retired -> dead) #' \item{apx}{retirement probability (active -> retirement), typically 1 for a fixed age}
#' * hx: probability of a widow at moment of death (dead -> widow), y(x) age differene #' \item{apx}{retirement probability of invalids (invalid -> retirement), typically 0 or 1 for a fixed age}
#' * qxw: death probability of widows/widowers #' \item{qpx}{death probability of retired (retired -> dead)}
#' * qgx: death probability of total group (irrespective of state) #' \item{hx}{probability of a widow at moment of death (dead -> widow), y(x) age difference}
#' \item{qxw}{death probability of widows/widowers}
#' \item{qgx}{death probability of total group (irrespective of state)}
#' }
#' #'
#' @slot qx Death probability table of actives (derived from mortalityTable) #' @slot qx Death probability table of actives (derived from mortalityTable)
#' @slot ix Invalidity probability of actives (derived from mortalityTable) #' @slot ix Invalidity probability of actives (derived from mortalityTable)
......
...@@ -10,24 +10,26 @@ Class \code{pensionTable} is the (virtual) base class for all pensions ...@@ -10,24 +10,26 @@ Class \code{pensionTable} is the (virtual) base class for all pensions
tables. It contains the name and some general values applying to all 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 types of tables. In particular, it holds individual tables for each of the
transition probabilities. Possible states are: transition probabilities. Possible states are:
* active: healty, no pension, typically paying some kin of premium \itemize{
* incapacity: disablity pension, in most cases permanent, not working, early pension \item active: healty, no pension, typically paying some kin of premium
* retirement: old age pension, usually starting with a fixed age \item incapacity: disablity pension, in most cases permanent, not working, early pension
* dead \item retirement: old age pension, usually starting with a fixed age
* Widow/widower pension \item dead \itemize{
\item Widow/widower pension
}
}
Correspondingly, the following transition probabilities can be given:\describe{
\item{qxaa}{death probability of actives (active -> dead)}
\item{ix}{invalidity probability (active -> incapacity)}
\item{qix}{death probability of invalid (invalid -> dead)}
\item{rx}{reactivation probability (incapacity -> active)}
\item{apx}{retirement probability (active -> retirement), typically 1 for a fixed age}
\item{apx}{retirement probability of invalids (invalid -> retirement), typically 0 or 1 for a fixed age}
\item{qpx}{death probability of retired (retired -> dead)}
\item{hx}{probability of a widow at moment of death (dead -> widow), y(x) age difference}
\item{qxw}{death probability of widows/widowers}
\item{qgx}{death probability of total group (irrespective of state)}
} }
\details{
Correspondingly, the following transition probabilities can be given:
* qxaa: death probability of actives (active -> dead)
* ix: invalidity probability (active -> incapacity)
* qix: death probability of invalid (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
* qpx: 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
* qgx: death probability of total group (irrespective of state)
} }
\section{Slots}{ \section{Slots}{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment