summary.lyl_range: Summarize Life Years Lost over a range of differents ages

View source: R/lyl_summary.R

summary.lyl_rangeR Documentation

Summarize Life Years Lost over a range of differents ages

Description

summary for objects of class lyl_range summarizes Life Years Lost over a range of different ages.

Usage

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

Arguments

object

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

decimals

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

weights

Vector with age distribution of disease/condition onset. If weights are not provided (dafault is weights = NA), then the differences in Life Years Lost at each age are summarized. If weights are provided, then a weighted average is provided.

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_range for estimation of Life Years Lost for a range of different ages.

Examples

# Load simulated data as example
data(simu_data)


# Estimate remaining life expectancy and Life Years
# Lost after each age from 0 to 94 years and before age 95 years
lyl_estimation <- lyl_range(data = simu_data, t = age_death, status = death,
                            age_begin = 0, age_end = 94, tau = 95)

# Visualize data at each different specific age
summary(lyl_estimation)

# Summarize data over an age distribution
summary(lyl_estimation, weights = simu_data$age_disease)


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