From 92c1602f0ad9dd36d3b18c5c6d28f20e3d019217 Mon Sep 17 00:00:00 2001
From: Reinhold Kainhofer <reinhold@kainhofer.com>
Date: Wed, 13 Sep 2017 09:18:51 +0000
Subject: [PATCH] Fix docstring (lists)
---
R/pensionTable.R | 37 ++++++++++++++++++++-----------------
man/pensionTable-class.Rd | 36 +++++++++++++++++++-----------------
2 files changed, 39 insertions(+), 34 deletions(-)
diff --git a/R/pensionTable.R b/R/pensionTable.R
index d06da1d..2920edb 100644
--- a/R/pensionTable.R
+++ b/R/pensionTable.R
@@ -8,23 +8,26 @@ NULL
#' 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
-#'
-#' 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)
+#' \itemize{
+#' \item active: healty, no pension, typically paying some kin of premium
+#' \item incapacity: disablity pension, in most cases permanent, not working, early pension
+#' \item retirement: old age pension, usually starting with a fixed age
+#' \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)}
+#' }
#'
#' @slot qx Death probability table of actives (derived from mortalityTable)
#' @slot ix Invalidity probability of actives (derived from mortalityTable)
diff --git a/man/pensionTable-class.Rd b/man/pensionTable-class.Rd
index d5e8a83..0299a51 100644
--- a/man/pensionTable-class.Rd
+++ b/man/pensionTable-class.Rd
@@ -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
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
+\itemize{
+ \item active: healty, no pension, typically paying some kin of premium
+ \item incapacity: disablity pension, in most cases permanent, not working, early pension
+ \item retirement: old age pension, usually starting with a fixed age
+ \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}{
--
GitLab