calc.LL.quantile: Compute the time to statistical cure using the loss of...

View source: R/calc.LL.quantile.R

calc.LL.quantileR Documentation

Compute the time to statistical cure using the loss of lifetime function

Description

The following function estimates the time to statistical cure using the loss of lifetime function.

Usage

calc.LL.quantile(
  fit,
  q = 1,
  newdata = NULL,
  max.time = 20,
  var.type = c("ci", "n"),
  exp.fun = NULL,
  rmap = NULL,
  ratetable = cuRe::survexp.dk,
  tau = 100,
  type = "ll",
  scale = ayear
)

Arguments

fit

Fitted model to do predictions from. Possible classes are gfcm, cm, stpm2, and pstpm2.

q

Threshold to estimate statistical cure according to.

newdata

Data frame from which to compute predictions. If empty, predictions are made on the the data which the model was fitted on.

max.time

Upper boundary of the interval [0, max.time] in which to search for solution (see details). Default is 20.

var.type

Character. Possible values are "ci" (default) for confidence intervals, "se" for standard errors, and "n" for neither.

exp.fun

Object of class list containing functions for the expected survival of each row in newdata. If not specified, the function computes the expected survival based on newdata using the survival::survexp function. If newdata is not provided, the expected survival is based on the data which the model was fitted on.

rmap

List to be passed to survexp from the survival package if exp.fun = NULL. Detailed documentation on this argument can be found by ?survexp.

ratetable

Object of class ratetable used to compute the general population survival. Default is survexp.dk

tau

Upper bound of integral (see ?calc.LL). Default is 100.

type

Type of life expectancy measure. Possible values are type = "ll" for the loss of lifetime and type = "mrl" for the mean residual lifetime.

scale

Numeric. Passed to the survival::survexp function and defaults to 365.24. That is, the time scale is assumed to be in years.

Value

The estimated cure point.

Examples

##Use data cleaned version of the colon cancer data from the rstpm2 package
data("colonDC")
set.seed(2)
colonDC <- colonDC[sample(1:nrow(colonDC), 1000), ]

##Extract general population hazards
colonDC$bhaz <- general.haz(time = "FU", rmap = list(age = "agedays", sex = "sex", year= "dx"),
                            data = colonDC, ratetable = survexp.dk)

#Fit cure model and estimate cure point
fit <- rstpm2::stpm2(Surv(FUyear, status) ~ 1, data = colonDC, df = 6,
                     bhazard = colonDC$bhaz, cure = TRUE)
calc.LL.quantile(fit, q = 1,
                 rmap = list(age = agedays, sex = sex, year = dx))

cuRe documentation built on July 9, 2023, 7 p.m.

Related to calc.LL.quantile in cuRe...