pensionTables.list: List all available sets of pension tables provided by the...

Description Usage Arguments Examples

View source: R/mortalityTables.list.R

Description

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

Usage

1
2
3
4
pensionTables.list(
  pattern = "*",
  package = c("^MortalityTables", "^PensionTables")
)

Arguments

pattern

Restrict the results only to pension 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.

Examples

1
2
3
pensionTables.list()
pensionTables.list("USA_*")
pensionTables.list(package = c("MyCustomPackage"))

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