- fit
a data frame as returned by surv_summary. Should contains at least
the following columns:
time: survival time
surv:
survival probability
strata: grouping variables
n.censor: number
of censors
upper: upper end of confidence interval
lower: lower
end of confidence interval
- fun
an arbitrary function defining a transformation of the survival
curve. Often used transformations can be specified with a character
argument: "event" plots cumulative events (f(y) = 1-y), "cumhaz" plots the
cumulative hazard function (f(y) = -log(y)), and "pct" for survival
probability in percentage.
- color
color to be used for the survival curves.
If the
number of strata/group (n.strata) = 1, the expected value is the color name.
For example color = "blue".
If n.strata > 1, the expected value is the
grouping variable name. By default, survival curves are colored by strata
using the argument color = "strata", but you can also color survival curves
by any other grouping variables used to fit the survival curves. In this
case, it's possible to specify a custom color palette by using the argument
palette.
- palette
the color palette to be used. Allowed values include "hue" for
the default hue color scale; "grey" for grey color palettes; brewer palettes
e.g. "RdBu", "Blues", ...; or custom color palette e.g. c("blue", "red"); and scientific journal palettes from ggsci R package, e.g.: "npg",
"aaas", "lancet", "jco", "ucscgb", "uchicago", "simpsons" and
"rickandmorty".
See details section for more information. Can be also a numeric vector of
length(groups); in this case a basic color palette is created using the
function palette.
- linetype
line types. Allowed values includes i) "strata" for changing
linetypes by strata (i.e. groups); ii) a numeric vector (e.g., c(1, 2)) or a
character vector c("solid", "dashed").
- break.x.by
alias of break.time.by. Numeric value controlling x axis
breaks. Default value is NULL.
- break.time.by
numeric value controlling time axis breaks. Default value
is NULL.
- break.y.by
same as break.x.by but for y axis.
- surv.scale
scale transformation of survival curves. Allowed values are
"default" or "percent".
- surv.geom
survival curve style. Is the survival curve entered a step
function (geom_step) or a smooth function (geom_line).
- xscale
numeric or character value specifying x-axis scale.
If numeric, the value is used to divide the labels on the x axis. For
example, a value of 365.25 will give labels in years instead of the original
days.
If character, allowed options include one of c("d_m", "d_y",
"m_d", "m_y", "y_d", "y_m"), where d = days, m = months and y = years. For
example, xscale = "d_m" will transform labels from days to months; xscale =
"m_y", will transform labels from months to years.
- conf.int
logical value. If TRUE, plots confidence interval.
- conf.int.fill
fill color to be used for confidence interval.
- conf.int.style
confidence interval style. Allowed values include
c("ribbon", "step").
- conf.int.alpha
numeric value specifying fill color transparency. Value
should be in [0, 1], where 0 is full transparency and 1 is no transparency.
- censor
logical value. If TRUE, censors will be drawn.
- censor.shape
character or numeric value specifying the point shape of
censors. Default value is "+" (3), a sensible choice is "|" (124).
- censor.size
numveric value specifying the point size of censors.
Default is 4.5.
- title
main title
- xlab
x axis label
- ylab
y axis label
- xlim
x axis limits e.g. xlim = c(0, 1000).
- ylim
y axis limits e.g. xlim = c(0, 1).
- axes.offset
logical value. Default is TRUE. If FALSE, set the plot axes
to start at the origin.
- legend
character specifying legend position. Allowed values are one of
c("top", "bottom", "left", "right", "none"). Default is "top" side position.
to remove the legend use legend = "none". Legend position can be also
specified using a numeric vector c(x, y); see details section.
- legend.title
legend title.
- legend.labs
character vector specifying legend labels. Used to replace
the names of the strata from the fit. Should be given in the same order as
those strata.
- ggtheme
function, ggplot2 theme name. Default value is
theme_survminer. Allowed values include ggplot2 official themes: see
theme.
- ...
other arguments to be passed i) to ggplot2 geom_*() functions such
as linetype, size, ii) or to the function ggpar() for
customizing the plots. See details section.