View source: R/simulate_from_dgm.R
| simulate_from_dgm | R Documentation |
Generates simulated survival data from a previously created AFT data generating mechanism (DGM). Samples from the super population and generates survival times with specified censoring.
simulate_from_dgm(
dgm,
n = NULL,
rand_ratio = 1,
entry_var = NULL,
max_entry = 24,
analysis_time = 48,
cens_adjust = 0,
draw_treatment = TRUE,
seed = NULL,
strata_rand = NULL,
hrz_crit = NULL,
keep_rand = FALSE,
time_eos = NULL,
replace = TRUE,
baseline = c("resample", "fixed"),
entry_delay = NULL
)
dgm |
An object of class |
n |
Integer specifying the sample size. If |
rand_ratio |
Numeric randomisation ratio (treatment:control).
Default |
entry_var |
Character string naming an entry-time variable in the
super population. If |
max_entry |
Numeric maximum entry time for staggered entry simulation.
Only used when |
analysis_time |
Numeric calendar time of analysis. Follow-up is
|
cens_adjust |
Numeric log-scale adjustment to censoring distribution.
Positive values increase censoring times; negative values decrease them.
Default |
draw_treatment |
Logical. If |
seed |
Integer random seed. Default |
strata_rand |
Character string naming a column in the sampled data
for within-stratum balanced treatment allocation. If |
hrz_crit |
Numeric log-HR threshold. If supplied, a column
|
keep_rand |
Logical. If |
time_eos |
Numeric secondary administrative censoring cutoff
(end-of-study time on the DGM scale). Applied after |
replace |
Logical sampling scheme for drawing the |
baseline |
Character; how baseline covariates are obtained per
simulated trial. |
entry_delay |
|
All time parameters (analysis_time, max_entry,
time_eos) must be expressed in the same units as
outcome_var supplied to generate_aft_dgm_flex(). A common
error is building the DGM on days (e.g. rfstime) and then passing
analysis_time in months, which causes follow-up windows far shorter
than the DGM event-time scale and produces universal administrative
censoring (event_sim = 0 for all subjects).
Verify with: exp(dgm$model_params$mu) — the implied median event
time should be plausible given your analysis_time.
When n = NULL the entire super population is used as-is, with no
staggered entry and no administrative censoring (follow_up = Inf).
Treatment assignments and linear predictors already stored in
dgm$df_super are retained unchanged.
cens_adjust shifts the log-scale location parameter of the
censoring distribution:
cens_adjust = log(2) doubles expected censoring times.
cens_adjust = log(0.5) halves expected censoring times.
baseline)Under baseline = "resample" each simulated trial is a fresh draw
of subjects, so between-trial variability reflects both covariate
resampling and outcome generation – the "what if this trial had enrolled
a different sample from the same population?" interpretation. Subgroup
sizes fluctuate across trials.
Under baseline = "fixed" the covariate matrix is the observed
trial data, identical in every simulated trial: subgroup definitions,
memberships, and sizes are exactly those of the source data. Between-trial
variability isolates the outcome-generation process (treatment
assignment, latent event times, censoring, entry). This is the
conditional-on-X (parametric-bootstrap-given-X) design. Note that entry
times are still drawn Uniform(0, max_entry) per trial unless
entry_var names a fixed column, and treatment is still
re-randomised per trial unless draw_treatment = FALSE.
A data.frame with columns:
idSubject identifier.
treatOriginal treatment from super population.
treat_simSimulated treatment assignment.
flag_harmSubgroup indicator (1 = all subgroup conditions met).
z_*Covariate values.
lin_pred_1, lin_pred_0Counterfactual log-time linear predictors.
y_simObserved survival time (min(T, C)).
event_simEvent indicator (1 = event, 0 = censored).
t_trueLatent true survival time (pre-censoring).
c_timeEffective censoring time (post admin-censoring).
hrz_flag(Optional) Individual harm-zone indicator.
rand_order(Optional) Randomisation sequence index.
generate_aft_dgm_flex, check_censoring_dgm
## Not run:
dgm <- setup_gbsg_dgm(model = "null", verbose = FALSE)
sim_data <- simulate_from_dgm(dgm, n = 200, seed = 42)
dim(sim_data)
head(sim_data[, c("y_sim", "event_sim", "treat_sim")])
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.