- response
A string describing the type of outcome in the data. Allowed values include
"count" (see catecvcount()
), "survival" (see
catecvsurv()
) and "continuous" (see catecvmean()
).
- data
A data frame containing the variables in the outcome, propensity score, and inverse
probability of censoring models (if specified); a data frame with n
rows (1 row per observation).
- cate.model
A formula describing the outcome model to be fitted.
The outcome must appear on the left-hand side. For survival outcomes,
a Surv
object must be used to describe the outcome.
- ps.model
A formula describing the propensity score (PS) model to be fitted. The treatment must
appear on the left-hand side. The treatment must be a numeric vector coded as 0/1.
If data are from a randomized controlled trial, specify ps.model = ~1
as an intercept-only model.
- ps.method
A character value for the method to estimate the propensity score.
Allowed values include one of:
'glm'
for logistic regression with main effects only (default), or
'lasso'
for a logistic regression with main effects and LASSO penalization on
two-way interactions (added to the model if interactions are not specified in ps.model
).
Relevant only when ps.model
has more than one variable.
- ipcw.model
A formula describing the inverse probability of censoring weighting (IPCW)
model to be fitted. The left-hand side must be empty. Only applies for survival outcomes.
Default is NULL
, which corresponds to specifying the IPCW with the same covariates
as the outcome model cate.model
, plus the treatment.
- ipcw.method
A character value for the censoring model. Only applies for survival
outcomes. Allowed values are: 'breslow'
(Cox regression with Breslow estimator of t
he baseline survivor function), 'aft (exponential)'
, 'aft (weibull)'
,
'aft (lognormal)'
or 'aft (loglogistic)'
(accelerated failure time model
with different distributions for y variable). Default is 'breslow'
.
- minPS
A numerical value (in `[0, 1]`) below which estimated propensity scores should be
truncated. Default is 0.01
.
- maxPS
A numerical value (in `(0, 1]`) above which estimated propensity scores should be
truncated. Must be strictly greater than minPS
. Default is 0.99
.
- followup.time
A column name in data
specifying the maximum follow-up time,
interpreted as the potential censoring time. Only applies for survival outcomes.
Default is NULL
, which corresponds to unknown potential censoring time.
- tau0
The truncation time for defining restricted mean time lost. Only applies for
survival outcomes. Default is NULL
, which corresponds to setting the truncation time as the
maximum survival time in the data.
- surv.min
Lower truncation limit for the probability of being censored.
It must be a positive value and should be chosen close to 0. Only applies for survival
outcomes. Default is 0.025
.
- interactions
A logical value indicating whether the outcome model should assume interactions
between x
and trt
. Applies only to count outcomes. If TRUE
, interactions will
be assumed only if at least 10 patients received each treatment option. Default is TRUE
.
- n.boot
A numeric value indicating the number of bootstrap samples used. Default is 500
.
- seed
An optional integer specifying an initial randomization seed for reproducibility.
Default is NULL
, corresponding to no seed.
- verbose
An integer value indicating whether intermediate progress messages and histograms should
be printed. 1
indicates messages are printed and 0
otherwise. Default is 0
.