R/generate_report.R

In purposeanalytics/lemur: Low-end of Market Rental Monitor

generate_report <- function(level, neighbourhood = NULL, format, filename = "report") {
  level <- match.arg(level, c("city", "neighbourhood"))
  format <- match.arg(format, c("pdf", "html"))

  if (level == "neighbourhood" & is.null(neighbourhood)) {
    stop("`neighbourhood` must be supplied if level = 'neighbourhood'", call. = FALSE)
  }

  if (level == "neighbourhood") {
    if (!neighbourhood %in% lemr::neighbourhoods[["neighbourhood"]]) {
      stop(neighbourhood, "is not a valid Toronto neighbourhood. See lemr::neighbourhoods", call. = FALSE)
    }
  }

  rmarkdown::render(system.file("reports/neighbourhood_profile.Rmd", package = "lemr"),
    params = list(
      level = level,
      neighbourhood = neighbourhood
    ),
    output_file = filename,
    output_format = glue::glue("{format}_document"),
    envir = new.env()
  )
}