Generate Diagnostic Report

Using one of the included templates, generate a diagnostic report based on a set of input parameters.

generate_report(template, params = NULL, output_dir = NULL, ...)

Arguments

template	character() Name of template used to generate report.
params	list() Parameters passed along to the chosen report template.
output_dir	character() Directory to write generated report to. Defaults to the current working directory.
...	Additional arguments passed on to rmarkdown::render().

Value

character() Invisible path to the generated report.

Examples

if (FALSE) {
# Proof of concept report
generate_report("test_report")

# Basic tend/level summary report
report_params <- list(
  old_data = old_data,
  new_data = new_data,
  level_threshold = 20,
  trend_bins = 1,
  comparison_var = "outcome",
  id_vars = c("year", "group"),
  group_vars = "group",
  trend_var = "year",
  scatter_color_var = "group"
)

generate_report(
  "level_trend_summary",
  params = report_params,
  output_dir = "~"
)

}