summary.lyl_aggregated: Summarize Life Years Lost at one specific age

View source: R/lyl_summary_aggregated.R

summary.lyl_aggregatedR Documentation

Summarize Life Years Lost at one specific age

Description

summary for objects of class lyl_aggregated summarizes Life Years Lost.

Usage

## S3 method for class 'lyl_aggregated'
summary(object, decimals = 2, ...)

Arguments

object

An object of class lyl_aggregated (obtained with function lyl_aggregated or lyl_aggregated_range).

decimals

Number of decimals to be reported (default is 2).

...

Additional arguments affecting the summary produced.

Value

A table with the summary of the results.

References

  • Plana-Ripoll et al. lillies – An R package for the estimation of excess Life Years Lost among patients with a given disease or condition. PLoS ONE. 2020;15(3):e0228073.

See Also

  • lyl_aggregated for estimation of Life Years Lost at one specific age.

  • lyl_aggregated_range for estimation of Life Years Lost for a range of different ages.

Examples

# Load simulated data as example
data(aggreg_data)
data(pop_ref)

# Estimate remaining life expectancy and Life Years
# Lost after age 70 years and before age 90 years
lyl_summary_data70 <- lyl_aggregated(data = aggreg_data, age = age, rates = rate,
                                     data0 = pop_ref, age0 = age, surv0 = survival,
                                     age_specific = 70, tau = 90)

# Summarize and plot the data
summary(lyl_summary_data70)


lillies documentation built on Aug. 7, 2023, 5:09 p.m.