ypsummary {ClinicalTrialSummary}R Documentation

The main function of the package provides five summary measures of the treatment effect for clinical trials.

Description

ypsummary provides estimates of several summary measures of the treatment effect for design and analysis of clinical trials with survival outcomes, introduced in Yang (2018). The function utilizes the short-term and long-term hazard ratio model proposed in Yang and Prentice (2005), which can acccomodate various nonproportional hazard scenarios. The asymptotic properties of the summary measures are also discussed in Yang and Prentice (2011), Yang (2013), and Yang (2018).

Usage

## Default S3 method:
ypsummary(time, event, group, tau, alpha = 0.05, tie = TRUE, 
    bound = 50, repnum = 2000, ...)

Arguments

...

for S4 method only.

time

A numeric vector of observations pooled from the two groups

event

A numeric vector of the right-censoring indicator (event = 1, censored = 0)

group

A numeric vector of the group indicator (treatment = 1, control = 0)

tau

the upper end of the range used in defining the summary measures. Must be user-specified.

alpha

Significance level. The default value is 0.05.

tie

The default is TRUE. Add very tiny values to the observations when sorting them to avoid ties.

bound

A boundary (-bound, bound) for estimating the parameters in the short-term and long-term hazard ratio model (Yang and Prentice, 2005). These parameters are \beta_1 and \beta_2 in their notations. The default boundary is (-50, 50).

repnum

the number of replications for the resampling method in obtaining the limiting variance estimators of the measures. The default value is 2000.

Details

The function ypsummary provides five summary measures of the treatment effect (see, Yang 2018), which can be utilized for various nonproportional haards scenarios:

where hr(x) is the hazard ratio of the treatment group over the control group, F_t(x) and F_c(x) are the distribution functions for the treatment group and control group, respectively, and S_t(x) = 1 - F_t(x) and S_c(x) = 1 - F_c(x). Note that all integrals are taken from 0 to \tau.

Value

Estimate

The point estimate for the corresponding summary meausure

CI

The confidence interval constructed by a re-sampling method. If the measure is a ratio, the z-value is the standardized log of the estimate. If the measure is a difference, the z-value is the standardized estimate.

z-value

Normally distributed value derived from the asymptotic results

p-value

the (two-sided) p-value using z-value

References

Yang, S. (2018). Improving testing and description of treatment effect in clinical trials with survival outcomes. Statistics in medicine.

Yang S, and Ross L. Prentice (2005). Semiparametric analysis of short-term and long-term hazard ratios with two-sample survival data. Biometrika, 92.1:1-17.

Yang S, and Ross L. Prentice (2011). Estimation of the 2-sample hazard ratio function using a semiparametric model. Biostatistics, 12.2:354-368.

Yang S. (2013). Semiparametric inference on the absolute risk reduction and the restricted mean survival difference in clinical trials. Special issue on risk assessment. Lifetime Data analysis, 19:219-241.

Examples

library(ClinicalTrialSummary)
data(ggas)
time <- ggas$time
event <- ggas$event
group <- ggas$group
result <- ypsummary(time, event, group, tau=8.2) # tau must be supplied.
result
summary(result)

[Package ClinicalTrialSummary version 1.1.1 Index]