summary.prodlim {prodlim}R Documentation

Summary method for prodlim objects.

Description

Summarizing the result of the product limit method in life-table format. Calculates the number of subjects at risk and counts events and censored observations at specified times or in specified time intervals.

Usage

## S3 method for class 'prodlim':
summary(object,
                times,
                newdata,
                verbose = TRUE,
                max.tables = 20,
                incidence = FALSE,
                cause=1,
                intervals = FALSE,
                proz = FALSE,
                ...)

Arguments

object An object with class `prodlim' derived with prodlim
times Vector of times at which to return the estimated probabilities.
newdata A data frame with the same variable names as those that appear on the right hand side of the 'prodlim' formula. Defaults to object$model.matrix.
verbose If FALSE supress all warnings and the printing of the summary.
max.tables Integer. If newdata is not given the value of max.tables decides about the maximal number of tables to be shown. Defaults to 20.
incidence Logical. If TRUE report event probabilities instead of survival probabilities. Only when object$model=="survival".
cause The cause for predicting the cause-specific cumulative incidence function in competing risk models.
intervals Logical. If TRUE count events and censored in intervals between the values of times.
proz Logical. If TRUE all estimated values are multiplied by 100 and thus interpretable on a percent scale.
... Further arguments that are passed to the print function.

Details

For cluster-correlated data the number of clusters at-risk are are also given. Confidence intervals are displayed when they are part of the fitted object.

Value

A data.frame with the relevant information.

Author(s)

Thomas A. Gerds tag@biostat.ku.dk

See Also

prodlim, summary.Hist

Examples

 SurvFrame <- data.frame(time=1:10,status=rbinom(10,1,.5))
 x <- prodlim(formula=Hist(time=time,status!=0)~1,data=SurvFrame)
 summary(x)
 summary(x,times=c(1,5,10,12),proz=TRUE,intervals=TRUE,digits=3)

[Package prodlim version 1.0.5 Index]