reReg (version 1.3.0)

plot.Recur: Produce Event Plot or Mean Cumulative Function Plot

Description

Plot the event plot or the mean cumulative function (MCF) from an Recur object.

Usage

# S3 method for Recur
plot(
  x,
  mcf = FALSE,
  event.result = c("increasing", "decreasing", "asis"),
  mcf.adjrisk = TRUE,
  mcf.smooth = FALSE,
  control = list(),
  ...
)

Arguments

x

an object of class Recur returned by the Recur() function. See ?Recur for creating Recur objects.

mcf

an optional logical value indicating whether the mean cumulative function (MCF) will be plotted instead of the event plot (default).

event.result

an optional character string that is passed to the plotEvents() function as the result argument. See plotEvents. This argument is used to specify whether the event plot is sorted by the subjects' terminal time. The available options are

increasing

sort the terminal time from in ascending order (default). This places longer terminal times on top.

decreasing

sort the terminal time from in descending order (default). This places shorter terminal times on top.

asis

present the as is, without sorting.

mcf.adjrisk

an optional logical value that is passed to the plotMCF() function as the adjrisk argument. See plotMCF. This argument indicates whether risk set size will be adjusted. If mcf.adjrisk = TRUE, subjects leave the risk set after terminal times as in the Nelson-Aalen estimator. If mcf.adjrisk = FALSE, subjects remain in the risk set after terminal time.

mcf.smooth

an optional logical value that is passed to the plotMCF() function as the smooth argument. See plotMCF. This argument indicates whether to add a smooth curve obtained from a monotone increasing P-splines implemented in package scam.

control

a list of control parameters. See Details.

...

additional graphical parameters to be passed to methods.

Value

A ggplot object.

Details

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 "Subject" for event plot and "Cumulative mean" for MCF plot.

main

customizable title, the default value is "Recurrent event plot" when mcf = FALSE and "Sample cumulative mean function plot" when mcf = TRUE.

terminal.name

customizable label for terminal event, default value is "Terminal event".

recurrent.name

customizable legend title for recurrent event, default value is "Recurrent events".

recurrent.types

customizable label for recurrent event type, default value is NULL.

alpha

between 0 and 1, controls the transparency of points.

The xlab, ylab and main parameters can also be passed down without specifying a control list. See Examples.

References

Nelson, W. B. (1995) Confidence Limits for Recurrence Data-Applied to Cost or Number of Product Repairs. Technometrics, 37(2): 147--157.

See Also

Recur, plotEvents, plotMCF

Examples

# NOT RUN {
data(simDat)
reObj <- with(simDat, Recur(Time, id, event, status))

## Event plots:
plot(reObj)
plot(reObj, event.result = "decreasing")

## MCF plots
plot(reObj, mcf = TRUE)
plot(reObj, mcf = TRUE, mcf.adjrisk = FALSE)

## With (hypothetical) multiple event types
set.seed(1)
reObj2 <- with(simDat, Recur(Time, id, event * sample(1:3, nrow(simDat), TRUE), status))
plot(reObj2)
# }