Learn R Programming

simPH (version 1.3.2)

simGG.simspline: Plot simulated penalised spline hazards from Cox Proportional Hazards Models

Usage

## S3 method for class 'simspline':
simGG(obj, SmoothSpline = TRUE, FacetTime = NULL,
  from = NULL, to = NULL, rug = TRUE, rug_position = "identity",
  xlab = NULL, ylab = NULL, zlab = NULL, title = NULL,
  method = "auto", lcolour = "#2B8CBE", lsize = 1, pcolour = "#A6CEE3",
  psize = 1, alpha = 0.2, type = "ribbons", ...)

Arguments

obj
a simspline class object
SmoothSpline
logical whether or not to fit the simulations with smoothing splines. Creates a smoother plot. See smooth.spline for more information. Note: currently the degrees of freedom are set at 10.
FacetTime
a numeric vector of points in time where you would like to plot Hazard Rates in a facet grid. Only relevant if qi == 'Hazard Rate'. Note: the values of Facet Time must exactly match values of the time element of obj.
from
numeric time to start the plot from. Only relevant if qi = "Hazard Rate".
to
numeric time to plot to. Only relevant if qi = "Hazard Rate".
rug
logical indicating whether or not to include a rug plot showing the distribution of values in the sample used to estimate the coxph model. Only relevant when the quantity of interest is not "Hazard Rate".
rug_position
character string. The position adjustment to use for overlapping points in the rug plot. Use "jitter" to jitter the points.
xlab
a label for the plot's x-axis.
ylab
a label of the plot's y-axis. The default uses the value of qi.
zlab
a label for the plot's z-axis. Only relevant if qi = "Hazard Rate" and FacetTime == NULL.
title
the plot's main title.
method
what type of smoothing method to use to summarize the center of the simulation distribution.
lcolour
character string colour of the smoothing line. The default is hexadecimal colour lcolour = '#2B8CBE'}. Only relevant if qi = "Relative Hazard" or qi = "First Difference".

lsize{size of the smoothing lin