mortalityTable-class: Class mortalityTable

Description Slots

Description

Class mortalityTable is the (virtual) base class for all mortality tables. It contains the name and some general values applying to all types of tables, but does not contain any data itself. Use a child class to create actual mortality tables.

Slots

name

The human-readable name of the mortality table

baseYear

The base year of the mortality table (e.g. for tables with trend projection)

modification

A function that will be called with the final death probabilities to give the user a way to modify the final probabilities

loading

Additional security loading on the resulting table (single numeric value, e.g. 0.05 adds 5% security margin to the probabilities)

data

Placeholder list to make it possible to store any kind of data associated with the object inside the object (e.g. the underlying data used to derive the death probabilities, parameters for adjustment, etc.)


kainhofer/r-mortality-tables documentation built on Dec. 17, 2020, 3:53 a.m.