reconstruct.bs.coxph: reconstruct.bs.coxph function

View source: R/postprocessing.R

reconstruct.bs.coxphR Documentation

reconstruct.bs.coxph function

Description

When bs(varname) has been used in the formula of a coxph model, this function can be used to reconstruct the predicted relative risk of that parameter over time.

Usage

## S3 method for class 'coxph'
reconstruct.bs(
  mod,
  varname,
  fun = NULL,
  probs = c(0.025, 0.975),
  bw = FALSE,
  xlab = NULL,
  ylab = NULL,
  plot = TRUE,
  ...
)

Arguments

mod

model output, created by function survspat

varname

name of the variable modelled by a B-spline

fun

optional function to feed in. Default is to plot relative risk against the covariate of interest. Useful choices include "identity" (but with no quotes), which plots the non-linear effect on the scale of the linear predictor.

probs

upper and lower quantiles for confidence regions to plot> The default is c(0.025,0.975).

bw

Logical. Plot in black/white/greyscale? Default is to produce a colour plot. Useful for producing plots for journals that do not accept colour plots.

xlab

label for x axis, there is a sensible default

ylab

label for y axis, there is a sensible default

plot

logical, whether to plot the effect of varname over time

...

other arguments to be passed to the plotting function.

Value

median, upper and lower confidence bands for the effect of varname over time; the funciton also produces a plot.


spatsurv documentation built on Oct. 19, 2023, 9:07 a.m.