pT.setDimInfo: Set additional information (year, description, type of risk,...

Description Usage Arguments Examples

View source: R/utilityFunctions.R

Description

A mortalityTable can store additional information to be used e.g. as additional dimensions in ggplot calls. Typically, these information include sex, base population, observation year, type of data (raw, smoothed), country, type of risk, etc. These additional dimensions are stored in the tbl@data list and will be used by plotMortalityTables and similar functions. pT.setDimInfo works just like mT.setDimInfo, except that it sets the information for all sub-tables of the pension table at the same time.

Usage

1

Arguments

tbl

The pensionTable object to assign dimensional information

...

The dimensional information as named arguments. All names except tbl and append are allowed.

append

Whether to append to existing dimensional data (append=TRUE) or completely replace existing information (append=FALSE)

Examples

1
# For examples, please see the \code{mT.setDimInfo} function.

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