getTBinR (version 0.7.1)

render_country_report: Render a Country Level TB Report

Description

This function renders a country level TB report.

Usage

render_country_report(
  country = "United Kingdom",
  format = "html_document",
  interactive = FALSE,
  save_dir = NULL,
  filename = NULL
)

Arguments

country

Character string, defaults to "United Kingdom". Specify the country to report on.

format

Character string, defaults to "html_document". The format to render the report to. See ?rmarkdown::render for details.

interactive

Logical, defaults to FALSE. When the format allows should graphs be interactive.

save_dir

Character string, defaults to NULL. If not given then the report is rendered to a temporary directory (although only if filename is also not given).

filename

Character string defaults NULL. Name to save the report under, defaults to "country_report".

Value

Renders a country level TB report

Examples

# NOT RUN {
## Only run the example if in an interative session
# }
# NOT RUN {
## Run the TB dashboard
render_country_report()
# }