set_all_stremr_options: Setting all possible 'stremr' options at once.

In osofr/estimtr: Streamlined Estimation for Static, Dynamic and Stochastic Treatment Regimes in Longitudinal Data

Description

Options that control stremr package. Calling this function will reset all unspecified options (omitted arguments) to their default values! The preferred way to set options for stremr is to use stremrOptions, which allows specifying individual options without having to reset all other options. To reset all options to their defaults simply run set_all_stremr_options() without any parameters/arguments.

Usage

set_all_stremr_options(
  fit_method = c("none", "cv"),
  fold_column = NULL,
  lower_bound_zero_Q = TRUE,
  skip_update_zero_Q = TRUE,
  up_trunc_offset = 20,
  low_trunc_offset = -10,
  eps_tol = 10^-5
)

Arguments

fit_method	Specify the default method for model selection. Possible options are "none" - no model selection and no cross-validation (when using only a single model, e.g., speedglm__glm) or "cv" - perform V-fold cross-validation to select the best model based on lowest MSE. Note that when codefit_method = "cv", the argument fold_column also needs to be specified.
fold_column	The column name in the input data (ordered factor) that contains the fold IDs to be used as part of the validation sample. Use the provided function define_CVfolds to define such folds or define the folds using your own method.
lower_bound_zero_Q	Set to TRUE to bound the observation-specific Qs during the TMLE update step away from zero (with minimum value set at 10^-4). Can help numerically stabilize the TMLE intercept estimates in some small-sample cases. Has no effect when TMLE = FALSE.
skip_update_zero_Q	Set to FALSE to perform TMLE update with glm even when all of the Q's are zero. When set to TRUE the TMLE update step is skipped if the predicted Q's are either all 0 or near 0, with TMLE intercept being set to 0.
up_trunc_offset	The upper bound for the TMLE offset during the TMLE GLM update step.
low_trunc_offset	The lower bound for the TMLE offset during the TMLE GLM update step.
eps_tol	Used for TMLE GLM update step. Set the tolerance for testing that the outcomes (Qkplus1) are all 0 or are all 1.

Value

Invisibly returns a list with old option settings.

See Also

stremrOptions, print_stremr_opts

osofr/estimtr documentation built on Jan. 25, 2022, 8:05 a.m.