kmciLRtidy.object {bpcp}R Documentation

Kaplan-Meier (Survival Curve) Confidence Interval LR Tidy Object

Description

The kmciLRtidy class is returned by the function bpcpfit when the plotstyle = "ggplot", and represents a fitted survival curve with pointwise confidence intervals. This object may contain more than one fitted survival curve with the corresponding pointwise confidence intervals based on a treatment/grouping variable, if one is specified in the formula of bpcpfit.

The kmciLRtidy class allows for confidence intervals to change at any time point (similar to the kmciLR class), while the kmci class only has the confidence intervals change at observed failures.

Objects of this class has methods for the functions summary, plot, print, quantile, and median.

When printed, objects of this class will display the total number of subjects, total number of events, median survival time, and the confidence limits(for the pre-specified confidence level), by treatment group if applicable.

Arguments

cens

time points where there is censoring but no observed failure

surv

the estimate of survival in the interval described by L and R. This is a vector.

upper

upper confidence limit for the survival curve in the interval described by L and R.

lower

lower confidence limit for the survival curve in the interval described by L and R.

L

vector of left ends of interval associated with lower and upper

Lin

vector of logicals, should left end of interval be included?

R

vector of right ends of interval associated with lower and upper

Rin

vector of logicals, should right end of interval be included?

Interval

character vector describing intervals

stype

character vector giving type of survival estimate, either 'km' or 'mue'

conf.level

the level of the confidence limits, e.g., 0.95.

num

total number of subjects at the start of that survival curve.

events

total number of events (observed failures) for that survival curve.

Structure

A kmciLRtidy object is a list of kmciLR objects (also lists). The length of the kmciLRtidy object corresponds to the number of treatment/grouping variables; each item in the list is a kmciLR object for the given treatment (the name of each item in the list is the name of each group). If no grouping variable is given, the output is a list of 1 kmciLR object.

The following components must be included in each element of a legitimate kmciLRtidy object.

See Also

plot.kmciLRtidy, summary.kmciLRtidy, print.kmciLRtidy, quantile.kmciLRtidy, median.kmciLRtidy, bpcpfit.


[Package bpcp version 1.4.2 Index]