plot-methods: The plot methods for EventPrediction package

In scientific-computing-solutions/eventPrediction: Event Prediction in Clinical Trials with Time-to-Event Outcomes

Description

For x an EventData object, this method will plot a cloglog survival curve of the data. If x is an EventModel object, this method will plot a KM curve of the data overlaid with the survival function from the model fit.

Usage

plot(x, y, ...)

## S4 method for signature 'EventData,missing'
plot(x, xlab = "log(t)",
  ylab = "log(-log(S(t)))", main = "", ...)

## S4 method for signature 'FromDataResults,missing'
plot(x,
  title = getFromDataResultsSummaryText(x, round.method = round.method,
  text.width = text.width, show.predictions = show.predictions),
  show.title = FALSE, text.width = 80, show.obs = FALSE,
  round.method = "None", show.predictions = TRUE, pred.to.present = FALSE,
  xlim = c(0, -1), ylim = NULL, include.dropouts = TRUE,
  legend.position = "bottomright", custom.dates = NULL)

## S4 method for signature 'EventModel,missing'
plot(x, units = "Days",
  xlab = paste("Time in study [", units, "]", sep = ""), ylab = "",
  main = "", ylim = NULL, xlim = NULL, ...)

## S4 method for signature 'AnalysisResults,missing'
plot(x, text = getFromParameterText(x,
  options = options), options = DisplayOptions(text.width = 110),
  show.title = TRUE, show.separate.arms = !isSingleArm(x@study),
  ylim = NULL)

Arguments

x	Standard arguments to plot generic
y	Standard arguments to plot generic
...	Additional arguments for the plot function
xlab	X axis label.
ylab	Y axis label.
main	Plot title
title	The title text, by default it is summary(x)
show.title	Logical, if TRUE, will show title in plot.
text.width	Number of characters to wrap title text by.
show.obs	If TRUE, add a line and points displaying the observed events.
round.method	If the string "toMonths" then dates are rounded to the nearest month. For the lower confidence interval value the date 15 days earlier than the given value is rounded to the nearest month and for the upper confidence intervalvalue the date 15 dats later than the given value is rounded to the nearest month
show.predictions	If TRUE show brown dashed lines at the user specified prediction times/number of events.
pred.to.present	If TRUE, move all predictions from past to present. Beware.
xlim	X axis limits. If x is FromDataResults object then c(2,10) will display from 2 to 10 months after the first subject was recruited. Using c(0,-1) will show the entire graph
ylim	The y-axis range for the plot
include.dropouts	Include the cumulative dropouts on the graph (logical)
legend.position	The position of the graph legend
custom.dates	A vector of dates (in string or Date format) to be output on the x-axis if NULL then default dates will be used
units	Scale for the x-axis. "Days", "Months" or "Years"
text	Text to display be in title, e.g. output from the getSummaryText() function.
options	Use this to customize the output.
show.separate.arms	Logical, if TRUE (and if x is a two arm study) the expected event curves for the separate arms are displayed on the graph, otherwise do not show the curves.

scientific-computing-solutions/eventPrediction documentation built on May 29, 2019, 3:44 p.m.