- data
A data.frame
with rows representing subjects and the
following named columns:
entrytime
:
time of entry into study (numeric);
survtime
:
time from entry until event (numeric);
censorid
:
censoring indicator (0 = right censored, 1 = observed),
(integer).
and optionally additional covariates used for risk-adjustment.
theta
The expected log-hazard ratio \(\theta\) under the alternative hypothesis.
If \(\theta >= 0\), the chart will try to detect an increase
in hazard ratio (upper one-sided). If \(\theta < 0\),
the chart will look for a decrease in hazard ratio (lower one-sided).
coxphmod
A Cox proportional hazards regression model as
produced by
the function coxph()
. Suggested:
coxph(Surv(survtime, censorid) ~ covariates, data = data)
.
Alternatively, a list with the following elements:
formula
:
a formula()
in the form ~ covariates
;
coefficients
:
a named vector specifying risk adjustment coefficients
for covariates. Names must be the same as in formula
and colnames of data
.
cbaseh
A function that returns the unadjusted cumulative
baseline hazard \(H_0(t)\). If cbaseh
is missing but
coxphmod
has been
specified as a survival object, this baseline hazard rate will be determined
using the provided coxphmod
.
ctimes
(optional): Vector of construction times at which the value of the chart should be
determined. When not specified, the chart is constructed at all failure times.
h
(optional): Value of the control limit. The chart will only be
constructed until the value of the control limit has been reached or
surpassed.
stoptime
(optional): Time after which the value of the chart should no
longer be determined. Default = max(failure time). Useful when ctimes
has not been specified.
C
(optional): A numeric value indicating how long after entering the study
patients should no longer influence the value of the chart. This is
equivalent to right-censoring every observation at time entrytime
+ C.
twosided
(optional): A boolean indicating whether a two-sided CUSUM
should be constructed.
If TRUE
, 2 CUSUM charts are determined. One to check for an increase
of \(e^\theta\) and one for
a decrease of \(e^{-\theta}\) in the hazard rate w.r.t.
the baseline hazard. Default is FALSE
.
pb
(optional): A boolean indicating whether a progress bar should
be shown. Default is FALSE
.
assist
(optional): Output of the function parameter_assist()