lyl_range {lillies}R Documentation

Life Years Lost at a range of different ages.

Description

lyl estimates remaining life expectancy and Life Years Lost for a given population after a range of specific ages (age_begin to age_end) and restrictied to a maximum theoretical age \tau.

Usage

lyl_range(
  data,
  t0 = NULL,
  t,
  status,
  age_begin,
  age_end,
  censoring_label = "Alive",
  death_labels = "Dead",
  tau = 100
)

Arguments

data

A dataframe, where each raw represents a person. The dataframe will have a time-to-event format with at least two variables: age at end of follow-up (t) and status indicator with death/censoring (status). Note that this package is not developed to be used with tibbles.

t0

Age at start of the follow-up time. Default is NULL, which means all subjects are followed from birth. For delayed entry, t0 indicates beginning of follow-up.

t

Age at the end of the follow-up time (death or censoring).

status

Status indicator, normally 0=alive, 1=dead. Other choices are TRUE/FALSE (TRUE = death) or 1/2 (2=death). For multiple causes of death (competing risks analysis), the status variable will be a factor, whose first level is treated as censoring; or a numeric variable, whose lowest level is treated as censoring. In the latter case, the label for censoring is censoring_label ("Alive" by default).

age_begin

Specific starting age at which the Life Years Lost have to be estimated.

age_end

Specific ending age at which the Life Years Lost have to be estimated.

censoring_label

Label for censoring status. If status is not a factor, "Alive" by default. If status is a factor, the first level will be treated as censoring label.

death_labels

Label for event status. For only one cause of death, "Dead" is the default. For multiple causes, the default are the values given in variable status.

tau

Remaining life expectancy and Life Years Lost are estimated restrictied to a maximum theoretical age \tau (\tau=100 years by default).

Value

A list with class "lyl_range" containing the following components:

References

See Also

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)
plot(lyl_estimation)

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

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

# Visualize data at each different specific age
summary(lyl_estimation2)
plot(lyl_estimation2)

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


[Package lillies version 0.2.12 Index]