LifeTable-class: S4 class for describing a life table.

In StatisticsNZ/demlife: Life Tables

Description

An object of class LifeTable holds values for 'mx' and 'ax', plus the life table 'radix' (ie l0). These provide sufficient information to calculate all life table functions.

Usage

## S4 method for signature 'LifeTable'
show(object)

Arguments

object

An object of class "LifeTable".

Details

At present, objects of class LifeTable can only handle single-decrement life tables. In future they will be extended to handle multiple-decrement and multi-state life tables.

Objects of class LifeTable also holds names of the life table functions that are displayed when the object is printed, that are included when the object is turned into a data.frame.

Slots

mx

An object of class Values, holding mortality rates.

ax

An object of class Values, with the same metadata as mx, holding separation factors.

radix

A positive number.

showFun

A character vector with names of life table functions.

showQuantiles

TRUE or FALSE.

showTotal

TRUE or FALSE.

prob

A numeric vector.

See Also

Objects of class LifeTable are typically created using function LifeTable.

StatisticsNZ/demlife documentation built on April 27, 2021, 10:02 p.m.