SHELF (version 1.12.0)

survivalScenario: Scenario Testing for Survival Extrapolation

Description

Provides a plot and approximate 95 extrapolated surival time, based on a assumption of constant hazard after some specified time. Intended to be used as part of the SHELF protocol for elicitation for survival extrapolation.

Usage

survivalScenario(
  tLower = 0,
  tUpper,
  expLower,
  expUpper,
  tTarget,
  survDf,
  groups = unique(survDf$treatment),
  expGroup = unique(survDf$treatment)[1],
  useWeights = FALSE,
  xl = "Time",
  fontsize = 12,
  showPlot = TRUE
)

Value

A list containing the elements

KMplot

a ggplot2 plot object;

interval

an approximate 95 at the target extrapolation time.

Arguments

tLower

lower limit for x-axis.

tUpper

upper limit for x-axis.

expLower

start time at which constant hazard is assumed.

expUpper

end time for using data to estimate constant hazard; data after this time will be censored.

tTarget

target extrapolation time.

survDf

data frame with individual patient data. Needs three columns with names "time", "event" and "treatment" (in that order). For weighted observations (e.g. using propensity scores), include a fourth column "weights". Values in the "event" column should be 0 for a censored observation, and 1 otherwise. The "treatment" column should be included even if there is only one treatment group.

groups

character vector of names of the treatment group. Extracted from survDF by default.

expGroup

selected treatment group for extrapolating

useWeights

set to TRUE if survDf includes column of weights, as described in specification of survDf. This column is passed on to survival::survreg() and survival::survfit() as the case weights.

xl

x-axis label

fontsize

plot fontsize

showPlot

whether to display the plot

Examples

if (FALSE) {
sdf <- survival::veteran[, c("time", "status", "trt")]
colnames(sdf) <- c("time", "event", "treatment")
sdf$treatment <- factor(sdf$treatment, labels = c("standard", "test"))
survivalScenario(tLower = 0,tUpper = 150, expLower = 100, expUpper = 150,
tTarget = 250, survDf = sdf,
expGroup = "standard")
}