Produces a templated text summary of the estimation properties table, automatically populating numerical results from the simulation output. Useful for reproducible vignettes where interpretation paragraphs should update when simulations are re-run.
interpret_estimation_table(
results,
dgm,
analysis_method = "FSlg",
n_sims = NULL,
n_boots = 300,
digits = 2,
scenario = NULL,
cat = TRUE
)Invisibly returns the interpretation as a character string.
Data frame of simulation results (same as for
build_estimation_table).
DGM object with true parameter values.
Character. Which analysis method to summarise.
Default: "FSlg".
Integer. Total number of simulations (for detection rate).
If NULL (default), derived from nrow(results) after
filtering to the analysis method.
Integer. Number of bootstraps (for narrative). Default: 300.
Integer. Decimal places for reported values. Default: 2.
Character. One of "null" or "alt" (default).
Controls the interpretive framing:
"null": emphasises false-positive rate and selection bias
"alt": emphasises power, bias relative to true effect
If NULL, inferred from the DGM (hr_H_true == hr_Hc_true
implies null).
Logical. If TRUE (default), prints the paragraph via
cat(). If FALSE, returns it invisibly as a character string
(useful for programmatic insertion into Rmd via results = "asis").
build_estimation_table,
format_oc_results, get_dgm_hr