check_sitrep_templates: Run the templates found in the sitrep package.

In R4EPI/sitrep: Report templates and helper functions for applied epidemiology

Run the templates found in the sitrep package.

Description

Run the templates found in the sitrep package.

Usage

check_sitrep_templates(
  templates = available_sitrep_templates(),
  path = tempdir(),
  quiet = FALSE,
  progress = FALSE,
  mustwork = FALSE,
  output_format = NULL,
  clean = TRUE
)

Arguments

templates	a vector of templates to create and render
path	a directory in which to store the templates
quiet	if FALSE (default), a message will be printed for every template.
progress	if TRUE, then the progress of the template is printed to screen (passed to the quiet argument of rmarkdown::render()). Defaults to FALSE
mustwork	if TRUE, then the templates must work for the function to succeed. Defaults to FALSE, which will simply print the errors.
output_format	a character defining the output formats to use for the template files. Defaults to the output_format defined in the templates (which is word_document), but can be modified to html_document for cross-platform cromulence checking.
clean	if TRUE (default), this will remove the previous output file before rendering.

Value

the path where the templates were built.

Examples

## Not run: 
check_sitrep_templates("mortality")

## End(Not run)

R4EPI/sitrep documentation built on Feb. 8, 2023, 8:41 a.m.