ggquickeda (version 0.1.0)

GeomKmticks: Display tick marks on a Kaplan Meier curve

Description

Ticks are plotted at censoring times that are also not event times

Adds tickmarks at the times when there are censored observations but no events

Usage

GeomKmticks
geom_kmticks(mapping = NULL, data = NULL, stat = "kmticks",
  position = "identity", show.legend = NA, inherit.aes = TRUE,
  na.rm = TRUE, ...)

Arguments

mapping

Set of aesthetic mappings created by aes or aes_. If specified and inherit.aes = TRUE (the default), it is combined with the default mapping at the top level of the plot. You must supply mapping if there is no plot mapping.

data

The data to be displayed in this layer. There are three options:

If NULL, the default, the data is inherited from the plot data as specified in the call to ggplot.

A data.frame, or other object, will override the plot data. All objects will be fortified to produce a data frame. See fortify for which variables will be created.

A function will be called with a single argument, the plot data. The return value must be a data.frame., and will be used as the layer data.

stat

The statistical transformation to use on the data for this layer, as a string.

position

Position adjustment, either as a string, or the result of a call to a position adjustment function.

show.legend

logical. Should this layer be included in the legends? NA, the default, includes if any aesthetics are mapped. FALSE never includes, and TRUE always includes.

inherit.aes

If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders.

na.rm

If FALSE, the default, missing values are removed with a warning. If TRUE, missing values are silently removed.

...

other arguments passed on to layer. These are often aesthetics, used to set an aesthetic to a fixed value, like color = "red" or size = 3. They may also be parameters to the paired geom/stat.

Format

An object of class GeomKmticks (inherits from Geom, ggproto) of length 6.

Aesthetics

geom_kmticks understands the following aesthetics (required aesthetics are in bold):

• x The survival/censoring times. This is automatically mapped by stat_km

• y The survival probability estimates. This is automatically mapped by stat_km smallest level in sort order is assumed to be 0, with a warning

• alpha

• color

• linetype

• size

See Also

The default stat for this geom is stat_kmticks see that documentation for more options to control the underlying statistical transformation.

Examples

# NOT RUN {
library(ggplot2)
sex <- rbinom(250, 1, .5)
df <- data.frame(time = exp(rnorm(250, mean = sex)), status = rbinom(250, 1, .75), sex = sex)
ggplot(df, aes(time = time, status = status, color = factor(sex))) + geom_km() + geom_kmticks()
# }