plot_km: Visualization of Survival Distributions

Description Usage Arguments Details Value Acknowledgments Note Author(s) References See Also

Description

Function for plotting the cross-validated survival distributions of a sbh object. It plots the cross-validated Kaplan-Meir estimates of survival distributions between the highest risk (inbox) versus lower-risk (outbox) groups of observations (PRSP), or between the two specified fixed groups (PRGSP), if this option is used. The plot is done for a given peeling step (or number of steps) of the peeling sequence (inner loop of our PRSP or PRGSP) algorithm) of the sbh object, as specified by the user.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
  plot_km(object,
          main = NULL,
          xlab = "Time",
          ylab = "Probability",
          ci = TRUE,
          precision = 1e-3,
          mark = 3,
          col = ifelse(test = object$cvarg$peelcriterion != "grp", 
                       yes = c(1,2), 
                       no = c(3,4)), 
          lty = 1,
          lwd = 0.5,
          cex = 0.5,
          steps = 1:object$cvfit$cv.nsteps,
          add.caption = TRUE,
          text.caption = ifelse(test = object$cvarg$peelcriterion != "grp", 
                                yes = c("outbox","inbox"), 
                                no = levels(object$groups)), 
          nr = 3, 
          nc = 4,
          device = NULL, 
          file = "Survival Plots", 
          path = getwd(), 
          horizontal = TRUE, 
          width = 11,
          height = 8.5, ...)

Arguments

object

Object of class sbh as generated by the main function sbh.

main

Character vector. Main Title. Defaults to NULL.

xlab

Character vector. X-axis label. Defaults to "Time".

ylab

Character vector. Y-axis label. Defaults to "Probability".

ci

Logical scalar. Shall the 95% confidence interval be plotted? Defaults to TRUE.

precision

Precision of log-rank p-values of separation between two survival curves. Defaults to 1e-3.

mark

Integer scalar of mark parameter, which will be used to label the inbox and outbox curves. Defaults to 3.

col

Integer scalar specifying the color of the inbox and outbox curves (Defaults to c(1,2)), or of the two groups (Defaults to c(3,4)), depending on object$cvarg$peelcriterion.

lty

Integer scalar. Line type for the survival curve. Defaults to 1.

lwd

Numeric scalar. Line width for the survival curve. Defaults to 0.5.

cex

Numeric scalar specifying the size of the marks, symbol expansion used for titles, captions, and axis labels. Defaults to 0.5.

steps

Integer vector. Vector of peeling steps at which to plot the survival curves. Defaults to all the peeling steps of sbh object object.

add.caption

Logical scalar. Shall the caption be plotted? Defaults to TRUE.

text.caption

Character vector of caption content. Defaults to {"outbox","inbox"}, or levels(object$groups), depending on object$cvarg$peelcriterion.

nr

Integer scalar of the number of rows in the plot. Defaults to 3.

nc

Integer scalar of the number of columns in the plot. Defaults to 4.

device

Graphic display device in {NULL, "PS", "PDF"}. Defaults to NULL (standard output screen). Currently implemented graphic display devices are "PS" (Postscript) or "PDF" (Portable Document Format).

file

File name for output graphic. Defaults to "Survival Plots".

path

Absolute path (without final (back)slash separator). Defaults to the working directory path.

horizontal

Logical scalar. Orientation of the printed image. Defaults to TRUE, that is potrait orientation.

width

Numeric scalar. Width of the graphics region in inches. Defaults to 11.

height

Numeric scalar. Height of the graphics region in inches. Defaults to 8.5.

...

Generic arguments passed to other plotting functions, including plot.survfit (R package survival).

Details

Some of the plotting parameters are further defined in the function plot.survfit (R package survival). Step #0 always corresponds to the situation where the starting box covers the entire test-set data before peeling. Cross-validated LRT, LHR of inbox samples and log-rank p-values of separation are shown at the bottom of the plot with the corresponding peeling step. P-values are lower-bounded by the precision limit given by 1/A, where A is the number of permutations.

Value

Invisible. None. Displays the plot(s) on the specified device.

Acknowledgments

This work made use of the High Performance Computing Resource in the Core Facility for Advanced Research Computing at Case Western Reserve University. This project was partially funded by the National Institutes of Health NIH - National Cancer Institute (R01-CA160593) to J-E. Dazard and J.S. Rao.

Note

End-user plotting function.

Author(s)

Maintainer: "Jean-Eudes Dazard, Ph.D." jean-eudes.dazard@case.edu

References

See Also


PRIMsrc documentation built on May 2, 2019, 11:45 a.m.