Run opt-in distribution/copula/method coverage simulations

Usage

run_coverage_simulations(
  families = NULL,
  copulas = c("N", "C", "F", "G", "J", "t"),
  methods = .coverage_default_methods(),
  designs = "intercept",
  include_mixed = FALSE,
  output_dir = file.path("results", "coverage_simulations"),
  write_results = TRUE,
  write_summary = TRUE,
  compile_summary_pdf = FALSE,
  smooth_results_file = NULL,
  report_title = "Coverage Simulation Summary",
  ...
)

Arguments

families: Optional family names. Defaults to all supported non-mixed gamlss.dist families with q, p, and d functions.
copulas: Copula codes.
methods: Fit methods. Defaults to "gamlss", "rs_separate", "rs_joint", and "cg". Method "gamlss2" is also supported when the optional non-CRAN package is installed and explicitly requested. Standard comparator methods "gee", "glmm", "gam", and "glmmTMB" are available for families that map to common mean-model families.
designs: Simulation designs: "intercept", "covariate", "scale", "time_dependence", or "smooth".
include_mixed: Logical; include mixed-support gamlss.dist families in the candidate family grid.
output_dir: Directory for CSV/RDS outputs.
write_results: Write result files when TRUE.
write_summary: Write a LaTeX summary report when TRUE and write_results is also TRUE.
compile_summary_pdf: Compile the LaTeX summary to PDF when TRUE and a LaTeX installation is available.
smooth_results_file: Optional smooth smoke-test CSV to include in the generated summary report.
report_title: Title for the generated summary report.
...: Passed to the grid runner, e.g. n, times, max_outer_iter, dependence, missingness, and start_mode.

Value

A data frame of per-fit results. The return value also carries "parameter_results" and "runtime_summary" attributes.