summary.cfc.tbasis: Summarizing time-denominated CFC objects

Description Usage Arguments Value Author(s) See Also

View source: R/cfc_legacy.R

Description

summary method for class cfc.tbasis.

Usage

1
2
3
4
5
6
## S3 method for class 'cfc.tbasis'
summary(object,
  MARGIN = if (class(object)[2] == "matrix") NULL else 1,
  ...)
## S3 method for class 'summary.cfc.tbasis'
plot(x, t = 1, ci = 0.95, ...)

Arguments

object

An object of class "cfc.tbasis", usually the result of a call to cfc.tbasis.

MARGIN

Dimensions of cumulative incidence and event-free probability arrays to keep while averaging the remaining dimensions. If the cfc.tbasis object is a matrix, no averaging is performed, and the function returns the object unchanged. Note that for list objects, MARGIN must include 1 since it is meaningless to average out the time/probability dimension (which is always the first one).

x

An object of class "summary.cfc.tbasis", usually the result of a call to summary.cfc.tbasis.

t

Regular time step, or vector of time values, used for producing cumulative incidence and event-free probability plots.

ci

Confidence interval used in cumulative incidence and event-free probability plots.

...

Further arguments to be passed to/from other methods.

Value

The function summary.cfc.tbasis calculates the average of cumulative incidence and event-free probability functions as directed by MARGIN. For example, if the element ci1 of the object list is three-dimensional, then using MARGIN=c(1,2) causes the last dimension to be averaged out.

Author(s)

Alireza S. Mahani, Mansour T.A. Sharabiani

See Also

The model fitting function is cfc.tbasis. See summary and plot for descriptions of the generic methods. See cfc.pbasis for probability-denominated CFC, as well as usage examples.


CFC documentation built on June 21, 2017, 5:03 p.m.