joineR (version 1.2.8)

summary.jointdata: Summarise a jointdata object

Description

Generic function used to produce summaries of objects of class jointdata.

Usage

# S3 method for jointdata
summary(object, ...)

Value

A list with five elements. Each summarises an element of the

jointdata object:

subjects

Gives the number of subjects in the data set.

longitudinal

If longitudinal data is available, it gives the names and class, of the longitudinal variables.

survival

If survival data is available, it gives the number of subjects with failure and censored survival times.

baseline

If baseline covariates is available, it gives the names and class, of the baseline covariates.

times

If longitudinal data is available, it gives the unique longitudinal time measurements, if it is a balanced study. In case of unbalanced study, it will only state it is an unbalanced study.

Arguments

object

an object of class joint.

...

further arguments for the summary.

Author

Ines Sousa

See Also

jointdata, UniqueVariables.

Examples

data(heart.valve)
heart.surv <- UniqueVariables(heart.valve,
                              var.col = c("fuyrs", "status"), 
                              id.col = "num")
heart.valve.jd <- jointdata(survival = heart.surv, 
                            id.col = "num",
                            time.col = "time")
summary(heart.valve.jd)