MortalityTables (version 2.0.5)

mortalityTables.load: Load a named set of mortality tables provided by the MortalityTables package

Description

Load a named set of mortality tables provided by the MortalityTables package

Usage

mortalityTables.load(
  dataset,
  package = c("^MortalityTables", "^PensionTables"),
  prefix = "MortalityTables"
)

Arguments

dataset

The set(s) of life tables to be loaded. A list of all available data sets is provided by the function mortalityTables.list. Wildcards (*) are allowed to match and load multiple datasets.

package

The package that contains the dataset in its extdata/ directory. Defaults to all packages starting with names that start with "MortalityTables" or "PensionTables". Multiple packages can be given as a vector, even using regular expressions. This package is not automatically loaded. If a provided dataset needs its proving package loaded, it can do so explicitly.

prefix

The prefix for the data sets (default is "MortalityTables").

Examples

mortalityTables.list()
mortalityTables.load("Austria_Annuities_*")
mortalityTables.load("Austria_Annuities_AVOe2005R")
mortalityTables.load("*Annuities")
if (FALSE) mortalityTables.load("MyCustomTable", package = c("MyCustomPackage"))