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

View source: R/lyl_summary.R

summary.lylR Documentation

Summarize Life Years Lost at one specific age

Description

summary for objects of class lyl summarizes Life Years Lost at one specific age.

Usage

## S3 method for class 'lyl'
summary(object, decimals = 2, difference = FALSE, ...)

Arguments

object

An object of class lyl (obtained with function lyl).

decimals

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

difference

Parameter automatically created by the package.

...

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 for estimation of Life Years Lost at one specific age.

Examples

# Load simulated data as example
data(simu_data)

# Estimate remaining life expectancy and Life Years
# Lost after age 45 years and before age 95 years
lyl_estimation <- lyl(data = simu_data, t = age_death, status = death,
                      age_specific = 45, tau = 95)

# Summarize and plot the data
summary(lyl_estimation)


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

Related to summary.lyl in lillies...