showQuantiles: Whether a LifeTable objects shows quantiles.

In StatisticsNZ/demlife: Life Tables

Description

Extract or change the showQuantiles slot of an object of class LifeTable. The showQuantiles slot controls whether all iterations are shown, or just quantiles summarising those iterations, in a life table that has a dimension with dimtype "iterations".

Usage

showQuantiles(object)

showQuantiles(object) <- value

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

## S4 replacement method for signature 'LifeTable'
showQuantiles(object) <- value

Arguments

object	An object of class LifeTable.
value	Logical.

Details

showQuantiles does not affect the underlying data, which are always stored as iterations, rather than quantiles.

If object does not have a dimension with dimtype "iterations", then showQuantiles has no effect.

Value

The extraction function returns TRUE or FALSE, and the replacement function returns a LifeTable object with a new value for the showQuantiles slot.

See Also

Life tables are created using function LifeTable.

Examples

mx <- dembase::ValuesOne(c(0.2, 0.05, 0.1, 0.4),
               labels = c("0", "1-4", "5-9", "10+"),
               name = "age")
mx <- dembase::perturb(1000 * mx, n = 20) / 1000
lt <- LifeTable(mx)
lt
showQuantiles(lt)
showQuantiles(lt) <- FALSE
lt

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