Skip to contents

report() renders a self-contained HTML report from a moat_audit object. The report uses a package-local R Markdown template, so it does not require internet access while rendering.

Usage

report(audit, file = "moat_report.html", quiet = TRUE, ...)

Arguments

audit

A moat_audit object.

file

Output HTML file path. Defaults to "moat_report.html".

quiet

A single logical value passed to rmarkdown::render(). Defaults to TRUE.

...

Additional arguments passed to rmarkdown::render().

Value

The normalized output file path, invisibly.

Examples

if (FALSE) { # \dontrun{
data("toy_moat")
audit <- moat(toy_moat, outcome = "outcome", batch = "batch", n_perm = 99)
report(audit)
} # }