survSpearman (version 1.0.1)

visualBivarTimeToEvent: Plots bivariate right-censored data.

Description

Plots bivariate right-censored data distinguishing between uncensored, singly censored, and doubly censored observations.

Usage

visualBivarTimeToEvent(X, Y, deltaX, deltaY, labelX, labelY,
   xlim = NULL, ylim = NULL, dotSize = 0.7,
   segLength=abs(mean(diff(c(X, Y)))), scaleLegendGap = 1,
   legendCex = 1, labCex = 1, axisCex = 1)

Value

None

Arguments

X

Time to event or censoring for variable X. It indicates time to event if argument deltaX=1 and time to censoring if argument deltaX=0.

Y

Time to event or censoring for variable Y. It indicates time to event if argument deltaY=1 and time to censoring if argument deltaY=0.

deltaX

Event indicator for variable X. deltaX=1 if the event is observed and 0 if it is censored.

deltaY

Event indicator for variable Y. deltaY=1 if the event is observed and 0 if it is censored.

labelX

Label for the X event.

labelY

Label for the Y event.

xlim

The range for the X-axis (the same as parameter xlim in function plot()).

ylim

The range on the X-axis (the same as parameter ylim in function plot()).

dotSize

The size of the points (the same as parameter cex in function points()).

segLength

The length of the segment representing censored observations.

scaleLegendGap

Increases (if > 1) or decreases (if < 1) the distance between the labels in the legend;

legendCex

The size of the legend font (the same as parameter cex in function text()).

labCex

The size of xlab and ylab (the same as parameter cex.lab in function plot()).

axisCex

The size of axis labels (the same as parameter cex.axis in function plot()).

Author

Svetlana K Eden,

Details

Plots bivariate right-censored data distinguishing between uncensored, singly censored, and doubly censored observations. The singly and doubly censored observations are plotted as diamonds and squares, respectively, with a short segment on the right, which length is the same for X and Y. The legend is always plotted in the left upper corner.

Examples

X = c(0.5, 0.61, 0.6, 0.8, 0.78, 0.7, 0.9)
Y = c(0.44, 0.15, 0.77, 0.88, 0.22, 0.99, .33)
deltaX = c(1, 0, 1, 1, 0, 1, 0)
deltaY = c(1, 0, 1, 0, 1, 1, 1)

visualBivarTimeToEvent(X, Y, deltaX, deltaY, xlim = c(0, 1), ylim = c(0, 1),
                       labelX = "X", labelY = "Y", segLength = 0.05)