mortalityTables.list: List all available sets of life tables provided by the...

View source: R/mortalityTables.list.R

mortalityTables.listR Documentation

List all available sets of life tables provided by the MortalityTables-package package An existing life table can then be loaded with mortalityTables.load.

Description

List all available sets of life tables provided by the MortalityTables-package package An existing life table can then be loaded with mortalityTables.load.

Usage

mortalityTables.list(
  pattern = "*",
  package = c("^MortalityTables", "^PensionTables"),
  prefix = "MortalityTables"
)

Arguments

pattern

Restrict the results only to life table sets that match the pattern with wildcards (default: "*" to show all sets)

package

The package that contains the desired dataset in its extdata/ directory. Defaults to the "MortalityTables" package. Multiple packages can be given as a vector, even using regular expressions.

prefix

The file prefix, defaults to MortalityTables. Can be overridden to list other types of files, like "PensionTables"

Examples

mortalityTables.list()
mortalityTables.list("Austria_*")
mortalityTables.list("*Annuities")
mortalityTables.list(package = c("MyCustomPackage"))


MortalityTables documentation built on Nov. 2, 2023, 5:52 p.m.