lines: S3 methods for lines

lines.stpm2R Documentation

S3 methods for lines

Description

S3 methods for lines

Usage

## S3 method for class 'stpm2'
lines(x, newdata = NULL, type = "surv", col = 1, ci.col= "grey",
lty = par("lty"), ci = FALSE, rug = FALSE, var = NULL,
exposed = NULL, times = NULL,
type.relsurv = c("excess", "total", "other"),
ratetable = survival::survexp.us, rmap, scale = 365.24, ...)
## S3 method for class 'pstpm2'
lines(x, newdata = NULL, type = "surv", col = 1,
ci.col= "grey",
lty = par("lty"), ci = FALSE, rug = FALSE, var = NULL,
exposed = NULL, times = NULL, ...)

Arguments

x

an stpm2 object

newdata

required list of new data. This defines the unexposed newdata (excluding the event times).

type

specify the type of prediction

col

line colour

lty

line type

ci.col

confidence interval colour

ci

whether to plot the confidence interval band (default=TRUE)

rug

whether to add a rug plot of the event times to the current plot (default=TRUE)

var

specify the variable name or names for the exposed/unexposed (names are given as characters)

exposed

function that takes newdata and returns the exposed dataset. By default, this increments var (except for cure models, where it defaults to the last event time).

times

specifies the times. By default, this uses a span of the observed times.

type.relsurv

type of predictions for relative survival models: either "excess", "total" or "other"

scale

scale to go from the days in the ratetable object to the analysis time used in the analysis

rmap

an optional list that maps data set names to the ratetable names. See survexp

ratetable

a table of event rates used in relative survival when type.relsurv is "total" or "other"

...

additional arguments (add to the plot command)


rstpm2 documentation built on Oct. 17, 2022, 5:11 p.m.