kmplt: Plot Kaplan Meier curve

Description Usage Arguments Details Value Author(s) References Examples

View source: R/kmplt.R

Description

This function plots the survival curve for the provided data set as a Kaplan Meier plot. It can only be used for visualization and returns no numeric values.

Usage

1

Arguments

data

A data frame containing at least the two columns “censored” and “True_STs”. Where “censored” contains the censorship status of the subject as either “0/F” for ‘uncensored subjects’ or “$1$/T” for ‘censored subjects’. This information is essential to be able to plot the KM curve.

title

A string of characters denoting the title of the plot produced.

Details

Note that this function was intended only for visualization and does not return any numerical values as such.

Value

A plot of the survival function “S(t)” against the survival times (unit-less) as calculated for the provided data set.

Author(s)

Douaa Mugahid

References

Bland JM, Altman DG. Survival probabilities (the Kaplan-Meier method). BMJ 1998;317;1572\ http://www.bmj.com/statsbk/12.dtl

Examples

1
2
3
4
censored <- c(1, 0, 1, 1, 1, 0, 1, 0, 0, 0)
True_STs <- c(1, 4, 5, 4, 6, 3, 2, 1, 3, 4)
dat <- as.data.frame(cbind(True_STs, censored))
kmplt(dat, "test")

RCASPAR documentation built on Nov. 1, 2018, 3:48 a.m.