rmstKM: Calculate the RMST in each arm and the between-group...

Description Usage Arguments Value Examples

View source: R/rmstKM.R

Description

This function calculates an estimate of the RMST by calculating the area under the KM curve in each arm. The calculations are done using a function from the survRM2 package, for further information see the survRM2 documentation.

Usage

1
rmstKM(formula, data, trunc, alpha = 0.05)

Arguments

formula

A formula object, with the response on the left of a ~ operator, and the a single term for arm on the right. The response must be a survival object as returned by the Surv function.

data

A data.frame in which to interpret the variables named in the formula.

trunc

The time point to truncated the estimate of the RMST at.

alpha

The default is 0.05. (1-alpha) confidence intervals are reported.

Value

The Restricted Mean Survival Time computated by calculating the area under the KM curve for each arm.

Examples

1
2
3
4
5
# Load in an example data set
D <- rmst2.sample.data()

# Calculate the RMST based on the area under the KM approach
rmstKM(Surv(time, status) ~ arm, data=D, trunc=5, alpha=0.05)

scientific-computing-solutions/RMST documentation built on Feb. 20, 2018, 1:11 a.m.