Skip to contents

Generates a multi-sheet Excel workbook with a professional cover sheet including detailed methodological metadata for reproducibility.

In addition to the curated parameter table on the cover sheet, a 'Run Configuration' sheet is auto-generated by iterating over every element of `config`, together with the package version, the resolved initiation trend model, the bootstrap seed and the run time. Because it is generated rather than curated, a parameter added to the config in future cannot silently fall out of the report; diffing this sheet between two workbooks is the definitive check of whether two deliveries used the same settings. All config access uses `[[` because `$` partial-matches list names (the old table reported `kn_samp` as `kn` for exactly this reason).

Usage

write_excel_report(
  config,
  init_res,
  quit_res,
  relapse_res,
  net_init_dt = NULL,
  quit_no_init = NULL
)

Arguments

config

Configuration list containing metadata and model parameters.

init_res

Initiation results list/dataframe.

quit_res

Quitting results list/dataframe.

relapse_res

Relapse results list/dataframe.

net_init_dt

Optional net initiation table (can be NULL).

quit_no_init

Optional quitting without initiation table (can be NULL).