Write a LaTeX summary report for coverage simulations

Usage

write_coverage_summary_report(
  prefix = NULL,
  results = NULL,
  parameter_results = NULL,
  smooth_results = NULL,
  results_file = NULL,
  parameter_results_file = NULL,
  smooth_results_file = NULL,
  output_tex = NULL,
  compile_pdf = FALSE,
  title = "Coverage Simulation Summary",
  run_label = NULL,
  top_n = 10
)

Arguments

prefix: Optional coverage-run file prefix. When supplied, the function looks for paste0(prefix, "_final_results.csv") and paste0(prefix, "_final_parameter_results.csv").
results: Optional per-fit coverage results data frame.
parameter_results: Optional eta-scale parameter results data frame.
smooth_results: Optional smooth smoke-test results data frame.
results_file: Optional CSV file containing per-fit coverage results.
parameter_results_file: Optional CSV file containing eta-scale parameter results.
smooth_results_file: Optional CSV file containing smooth smoke-test results.
output_tex: Output .tex file. Defaults to paste0(prefix, "_summary.tex") when prefix is supplied.
compile_pdf: Compile the report to PDF when a LaTeX installation is available.
title: Report title.
run_label: Optional run label used in the report date/scope text.
top_n: Number of rows for "slowest" and "largest error" tables.

Value

Invisibly returns a list with tex_file, pdf_file, and compiled.