R/make_report.R

In erhla/cmfproperty: Property Tax Analysis

#' Produces an HTML report in the current working directory to evaluate regressivity in the supplied jurisdiction
#'
#' @param ratios a dataframe which has been preprocessed by \code{\link{reformat_data}}
#' @param jurisdiction_name the name of the jurisdiction being analyzed
#' @param output_dir optional, default is working directory
#' @param diagnostic optional, if TRUE includes additional sections evaluating data quality
#'
#' @return produces a file named `jurisdiction_name.html` in output_dir

#' @export
make_report <-
  function(ratios, jurisdiction_name, output_dir="", diagnostic=FALSE) {

  if (output_dir == ""){
    file_loc <- getwd()
  } else {
    file_loc <- output_dir
  }

  output_loc <- paste0(file_loc, "/", jurisdiction_name, ".html")

  rmarkdown::render(system.file("Rmd", "report.Rmd", package = "cmfproperty"),
                    params = list(title = jurisdiction_name,
                                  inputdata = ratios,
                                  diagnostic = diagnostic),
                    output_file = output_loc)
  print("~~~~~~~~~~~~")
  print("geom warnings can be disregarded") #these warnings are from data filtering
  print(paste0("Report created at ", output_loc))

}