reReg (version 1.3.0)

plotRate: Plotting the Baseline Cumulative Rate Function for the Recurrent Event Process

Description

Plot the baseline rate function for an reReg object.

Usage

plotRate(
  x,
  type = c("unrestricted", "scaled", "raw"),
  smooth = FALSE,
  control = list(),
  ...
)

Arguments

x

an object of class reReg, usually returned by the reReg function.

type

a character string specifying the type of rate function to be plotted. Options are "unrestricted", "scaled", "raw". See Details.

smooth

an optional logical value indicating whether to add a smooth curve obtained from a monotone increasing P-splines implemented in package scam.

control

a list of control parameters.

...

graphical parameters to be passed to methods. These include xlab, ylab, main, and more. See Details.

Value

A ggplot object.

Details

The plotRate() plots the estimated baseline cumulative rate function depending on the identifiability assumption. When type = "unrestricted" (default), the baseline cumulative rate function is plotted under the assumption \(E(Z) = 1\). When type = "scaled", the baseline cumulative rate function is plotted under the assumption \(\Lambda(\min(Y^\ast, \tau)) = 1\). When type = "raw", the baseline cumulative rate function is plotted under the assumption \(\Lambda(\tau) = 1\). See ?reReg for the specification of the notations and underlying models.

The argument control consists of options with argument defaults to a list with the following values:

xlab

customizable x-label, default value is "Time".

ylab

customizable y-label, default value is empty.

main

customizable title, default value is "Baseline cumulative rate function".

These arguments can also be passed down without specifying a control list. See Examples.

See Also

reReg plot.reReg

Examples

# NOT RUN {
data(simDat)
fm <- Recur(Time, id, event, status) ~ x1 + x2

fit <- reReg(fm, data = simDat, method = "cox", B = 0)
## Plot both the baseline cumulative rate and hazard function
plot(fit)
## Plot baseline cumulative rate function
plotRate(fit)
plotRate(fit, smooth = TRUE)
# }