pensionTable.R 15 KB
Newer Older
1
#' @include mortalityTable.R fillAges.R
2 3
NULL

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
pensionTableProbArrange = function(x, q, i, qi, r, ap, api, qp, h, qw, yx, qg, as.data.frame = TRUE, table, ...) {
    if (as.data.frame) {
        data.frame(x, q, i, qi, r, ap, api, qp, h, qw, yx, qg)
    } else {
        states = c("a", "i", "p", "d")
        transProb = array(0, dim = c(length(states), length(states), length(x)), dimnames = list(states, states, x))

        transProb["a", "a", ] = (1 - i - q) * (1 - ap);
        transProb["a", "i", ] = i;
        transProb["a", "p", ] = (1 - i - q) * ap;
        transProb["a", "d", ] = q;

        transProb["i", "a", ] = r;
        transProb["i", "i", ] = (1 - qi - r) * (1 - api);
        transProb["i", "p", ] = (1 - qi - r) * api;
        transProb["i", "d", ] = qi;

        transProb["p", "p", ] = 1 - qp;
        transProb["p", "d", ] = qp;

        transProb["d", "d", ] = 1;

        list(transitionProbabilities = transProb, widows = data.frame(x, h, qw, yx))
    }
}

30 31 32 33 34 35 36

#' Class pensionTable
#'
#' 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:
Reinhold Kainhofer's avatar
Reinhold Kainhofer committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
#' \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{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)}
55 56 57 58
#'     \item{invalids.retire}{Flag to indicate whether invalid persons retire
#'           like active (one death probability for all retirees) or whether
#'           they stay invalid until death with death probabilities specific to
#'           invalids.}
Reinhold Kainhofer's avatar
Reinhold Kainhofer committed
59
#' }
60 61 62
#'
#' @slot qx     Death probability table of actives (derived from mortalityTable)
#' @slot ix     Invalidity probability of actives (derived from mortalityTable)
63
#' @slot qix    Death probability table of invalids (derived from mortalityTable)
64 65 66 67 68 69 70
#' @slot rx     Reactivation probability of invalids (derived from mortalityTable)
#' @slot apx    Retirement probability of actives (derived from mortalityTable)
#' @slot qpx    Death probability of old age pensioners (derived from mortalityTable)
#' @slot hx     Probability of a widow at the moment of death (derived from mortalityTable)
#' @slot qwy    Death probability of widow(er)s (derived from mortality Table)
#' @slot yx     Age difference of the widow to the deceased
#' @slot qgx    Death probability of whole group (derived from mortalityTable), irrespective of state
71
#' @slot invalids.retire    Whether invalids retire like actives or stay invalid until death
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
#'
#' @export pensionTable
#' @exportClass pensionTable
pensionTable = setClass(
    "pensionTable",
    slots = list(
        qx    = "mortalityTable",
        ix    = "mortalityTable",
        qix   = "mortalityTable",
        rx    = "mortalityTable",
        apx   = "mortalityTable",
        qpx   = "mortalityTable",
        hx    = "mortalityTable",
        qwy   = "mortalityTable",
        yx    = "mortalityTable",
87
        qgx   = "mortalityTable",
88 89
        invalids.retire = "logical",
        probs.arrange = "function"
90 91
    ),
    prototype = list(
92 93
        invalids.retire = FALSE,
        probs.arrange = pensionTableProbArrange
94 95 96 97
    ),
    contains = "mortalityTable"
)

98
#' Return all transition probabilities of the pension table (generational probabilities)
99 100 101 102
#'
#' @param object A pension table object (instance of a \code{\linkS4class{pensionTable}} class)
#' @param ... Currently unused
#' @param YOB Year of birth
103
#' @param 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
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
#' @param Period Observation year to calculate period transition probabilities.
#'               If given, this arguments overrides the \code{YOB} parameter
#'               and this function returns period transition probabilities.
#'               If this argument is not given or is null, then this function
#'               returns generational transition probabilities.
#' @param as.data.frame Whether the return value should be a data.frame or an
#'                      array containing transition matrices
#' @param retirement Override the retirement transition probabilities of the
#'                   pension table. Possible values are:\itemize{
#'                     \item Single age (describing a deterministric retirement at the given age)
#'                     \item mortalityTable object: transition probabilities for retirement
#'                   }
#' @param invalids.retire Override the \code{\linkS4class{pensionTable}}'s
#'                        \code{invalids.retire} flag, which indicates whether
#'                        invalids retire like actives (i.e. same death
#'                        probabilities after retirement) or stay invalid until
#'                        death.
121
#' @param OverallMortality Whether the overall mortality should be returned for actives, or the active mortality
122 123
#'
#' @examples
124 125 126 127
#' pensionTables.load("USA_PensionPlans")
#' transitionProbabilities(RP2014.male, YOB = 1962)
#' transitionProbabilities(RP2014.male, Period = 1955)
#' transitionProbabilities(RP2014.male, Period = 2025)
128 129
#'
#' @exportMethod transitionProbabilities
130
setGeneric("transitionProbabilities", function(object, ...) standardGeneric("transitionProbabilities"));
131

132
#' @describeIn transitionProbabilities Return all transition probabilities of the pension table for the generation YOB
133
setMethod("transitionProbabilities", "pensionTable",
134
          function(object, YOB = 1982, ..., ages = NULL, OverallMortality = FALSE, Period = NULL, retirement = NULL,
135 136 137
                   invalids.retire = object@invalids.retire, as.data.frame = TRUE) {
              if (!missing(Period) && !is.null(Period)) {
                  return(periodTransitionProbabilities(
138
                      object, ..., ages = ages, Period = Period, retirement = retirement,
139 140 141
                      invalids.retire = invalids.retire,
                      as.data.frame = as.data.frame))
              }
142
              x   = if (is.null(ages)) ages(object@qx) else  ages;
143 144 145 146
              q   = deathProbabilities(object@qx, ..., ages = ages, YOB = YOB);
              i   = deathProbabilities(object@ix, ..., ages = ages, YOB = YOB);
              qi  = deathProbabilities(object@qix, ..., ages = ages, YOB = YOB);
              r   = deathProbabilities(object@rx, ..., ages = ages, YOB = YOB);
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
              apTab = object@apx
              if (!missing(retirement) && !is.null(retirement)) {
                  if (inherits(retirement, "mortalityTable")) {
                      apTab = retirement
                  } else if (is.numeric(retirement) && length(retirement) == 1) {
                      # Single retirement age given
                      apTab = mortalityTable.once(
                          transitionAge = retirement - 1, ages = x,
                          name = paste("Retirement at age ", retirement))
                  } else {
                      warning("transitionProbabilities: Invalid value for ",
                              "argument retirement. Allowed are only: numeric ",
                              "(retirement age) or mortalityTable (retirement ",
                              "probabilities). Given: ", retirement);
                      apTab = mortalityTable.zeroes(ages = x)
                  }
              }
164
              ap  = deathProbabilities(apTab, ..., ages = ages, YOB = YOB);
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179

              if (!missing(retirement) && !is.null(retirement)) {
                  if (inherits(retirement, "mortalityTable")) {
                  } else if (is.numeric(retirement) && length(retirement) == 1) {
                  } else {
                      warning("transitionProbabilities: Invalid value for ",
                              "argument retirement. Allowed are only: numeric ",
                              "(retirement age) or mortalityTable (retirement ",
                              "probabilities). Given: ", retirement);
                      apTab = mortalityTable.zeroes(ages = x)
                  }
              }
              if (invalids.retire) {
                  api = ap
              } else {
180
                  api = deathProbabilities(mortalityTable.zeroes(ages = x), ..., ages = ages, YOB = YOB)
181
              }
182 183 184 185 186
              qp  = deathProbabilities(object@qpx, ..., ages = ages, YOB = YOB);
              h   = deathProbabilities(object@hx, ..., ages = ages, YOB = YOB);
              qw  = deathProbabilities(object@qwy, ..., ages = ages, YOB = YOB);
              yx  = deathProbabilities(object@yx, ..., ages = ages, YOB = YOB);
              qg  = deathProbabilities(object@qgx, ..., ages = ages, YOB = YOB);
187
              if (!OverallMortality) {
188
                  object@probs.arrange(x, q, i, qi, r, ap, api, qp, h, qw, yx, qg, as.data.frame = as.data.frame, table = object)
189 190
              } else {
                  # Gesamttafel, i.e. actives, invalids and pensioners have the same mortality qg
191
                  object@probs.arrange(x, qg, i, qg, r, ap, api, qg, h, qw, yx, qg, as.data.frame = as.data.frame, table = object)
192
              }
193 194
          })

195
#' Return all period transition probabilities of the pension table
196 197
#'
#' @param object A pension table object (instance of a \code{\linkS4class{pensionTable}} class)
198
#' @param Period Observation year
199
#' @param ... Currently unused
200
#' @param 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
201 202 203 204 205 206 207 208 209
#' @param retirement Override the retirement transition probabilities of the pension table. Possible values are:\itemize{
#'                   \item Single age (describing a deterministric retirement at the given age)
#'                   \item mortalityTable object: transition probabilities for retirement
#'                   }
#' @param invalids.retire Override the \code{\linkS4class{pensionTable}}'s
#'                        \code{invalids.retire} flag, which indicates whether
#'                        invalids retire like actives (i.e. same death
#'                        probabilities after retirement) or stay invalid until
#'                        death.
210
#' @param as.data.frame Whether the return value should be a data.frame or an array containing transition matrices
211
#' @param OverallMortality Whether the overall mortality should be returned for actives, or the active mortality
212 213
#'
#' @examples
214 215 216 217 218 219
#' pensionTables.load("USA_PensionPlans")
#' # transitionProbabilities internally calls periodTransitionProbabilities
#' # if a Period is given:
#' transitionProbabilities(RP2014.male, Period = 1955)
#' periodTransitionProbabilities(RP2014.male, Period = 1955)
#' periodTransitionProbabilities(RP2014.male, Period = 2025)
220
#'
221 222
#' @exportMethod periodTransitionProbabilities
setGeneric("periodTransitionProbabilities", function(object, ...) standardGeneric("periodTransitionProbabilities"));
223 224


225 226
#' @describeIn periodTransitionProbabilities Return all transition probabilities of the pension table for the period Period
setMethod("periodTransitionProbabilities", "pensionTable",
227 228
          function(object, Period = 2017, ..., ages = NULL, OverallMortality = FALSE, retirement = NULL, invalids.retire = object@invalids.retire, as.data.frame = TRUE) {
              x   = if (is.null(ages)) ages(object@qx) else  ages;
229 230 231 232
              q   = periodDeathProbabilities(object@qx, ..., ages = ages, Period = Period);
              i   = periodDeathProbabilities(object@ix, ..., ages = ages, Period = Period);
              qi  = periodDeathProbabilities(object@qix, ..., ages = ages, Period = Period);
              r   = periodDeathProbabilities(object@rx, ..., ages = ages, Period = Period);
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
              apTab = object@apx
              if (!missing(retirement) && !is.null(retirement)) {
                  if (inherits(retirement, "mortalityTable")) {
                      apTab = retirement
                  } else if (is.numeric(retirement) && length(retirement) == 1) {
                      # Single retirement age given
                      apTab = mortalityTable.once(
                          transitionAge = retirement - 1, ages = x,
                          name = paste("Retirement at age ", retirement))
                  } else {
                      warning("transitionProbabilities: Invalid value for ",
                              "argument retirement. Allowed are only: numeric ",
                              "(retirement age) or mortalityTable (retirement ",
                              "probabilities). Given: ", retirement);
                      apTab = mortalityTable.zeroes(ages = x)
                  }
              }
250
              ap = deathProbabilities(apTab, ..., ages = ages, Period = Period)
251 252 253
              if (invalids.retire) {
                  api = ap
              } else {
254
                  api = deathProbabilities(mortalityTable.zeroes(ages = x), ..., ages = ages, Period = Period)
255
              }
256 257 258 259 260
              qp  = periodDeathProbabilities(object@qpx, ..., ages = ages, Period = Period);
              h   = periodDeathProbabilities(object@hx, ..., ages = ages, Period = Period);
              qw  = periodDeathProbabilities(object@qwy, ..., ages = ages, Period = Period);
              yx  = periodDeathProbabilities(object@yx, ..., ages = ages, Period = Period);
              qg  = periodDeathProbabilities(object@qgx, ..., ages = ages, Period = Period);
261
              if (!OverallMortality) {
262
                  object@probs.arrange(x, q, i, qi, r, ap, api, qp, h, qw, yx, qg, as.data.frame = as.data.frame, table = object)
263
              } else  {
264
                  object@probs.arrange(x, qg, i, qg, r, ap, api, qg, h, qw, yx, qg, as.data.frame = as.data.frame, table = object)
265
              }
266
          })
267

268

269
if (FALSE) {
270
    pensionTables.load("Austria_AVOe2008P")
271 272 273 274
    transitionProbabilities(AVOe2008P.male, YOB = 1977, as.data.frame = FALSE)
    epP = transitionProbabilities(EttlPagler.male, YOB = 1982)
#    avoe08p =
        transitionProbabilities(AVOe2008P.male, YOB = 1977, as.data.frame = TRUE)
275 276 277 278
avoe08p.period = periodTransitionProbabilities(AVOe2008P.male, Period = 2007, as.data.frame = TRUE)

pensionTables.list(package = "MortalityTablesPrivate")
pensionTables.load("Austria_AVOe1999P")
279
}
280