summary.probtrans.subjects: Summary method for a probtrans.subjects object

In hputter/mstate: Data Preparation, Estimation and Prediction in Multi-State Models

Summary method for a probtrans.subjects object

Description

Summary method for an object of class 'probtrans.subjects'. It prints a selection of the estimated transition probabilities. Wrapper for summary.probtrans.

Usage

## S3 method for class 'probtrans.subjects'
summary(object, id, times, from = 1, to = 0, extend = FALSE, ...)

Arguments

object	Object of class 'probtrans.subjects', containing estimated transition probabilities from and to all states in a multi-state model
id	Subject identifier
times	Time points at which to evaluate the transition probabilites
from	Specifies from which state the transition probabilities are to be printed. Should be subset of 1:S, with S the number of states in the multi-state model. Default is print from state 1 only. User can specify from=0 to print transition probabilities from all states
to	Specifies the transition probabilities to which state are to be printed. User can specify to=0 to print transition probabilities to all states. This is also the default
extend	logical value: if TRUE, prints information for all specified times, even if there are no subjects left at the end of the specified times. This is only valid if the times argument is present
...	Further arguments to summary.probtrans

Value

Function summary.probtrans returns an object of class "summary.probtrans", which is a list (for each from state) of transition probabilities at the specified (or all) time points. The print method of a summary.probtrans doesn't return a value.

Author(s)

Hein Putter and Daniel Gomon

See Also

summary.probtrans

Examples

# First run the example of probtrans
tmat <- trans.illdeath()
tg <- data.frame(illt=c(1,1,6,6,8,9),ills=c(1,0,1,1,0,1),
                 dt=c(5,1,9,7,8,12),ds=c(1,1,1,1,1,1),
                 x1=c(1,1,1,0,0,0),x2=c(6:1))
tglong <- msprep(time=c(NA,"illt","dt"),status=c(NA,"ills","ds"),
                 data=tg,keep=c("x1","x2"),trans=tmat)
tglong <- expand.covs(tglong,c("x1","x2"))
cx <- coxph(Surv(Tstart,Tstop,status)~x1.1+x2.2+strata(trans),
            data=tglong,method="breslow")
#Make newdata (3 subjects)
newdata <- data.frame(id=rep(1:3, each = 3),x1.1=c(0,0,0,1,0,1,0,1,0),
                      x2.2=c(0,1,0,0,0,0,1,0,1), trans = rep(1:3, 3))
HvH <- msfit_subjects(cx,newdata,trans=tmat)
pt <- probtrans_subjects(HvH,predt=0)

# Default, prediction from state 1
summary(pt,id = 1)
# Only from states 1 and 3
summary(pt,id=2, from=c(1, 3))
# Use from=0 for prediction from all states
summary(pt,id=3, from=0)
# Only to states 1 and 2
summary(pt,id=1, to=1:2)
# Transition probabilities only at specified time points
summary(pt,id=3, times=seq(0, 15, by=3))
# Last specified time point is larger than last observed, not printed
# Use extend=TRUE as in summary.survfit
summary(pt,id=1, times=seq(0, 15, by=3), extend=TRUE)
# When the number of time points specified is larger than 12, head and tail is shown
x <- summary(pt, id = 2, times=seq(5, 8, by=0.25))
x

hputter/mstate documentation built on July 17, 2025, 2:04 a.m.