R/generate.R

In jansim/WizRd: A tool to conjure a report for your data with little effort

#' Generate a WizRd Report
#'
#' @param df Dataframe to generate the Report for
#' @param pattern Pattern / Regex to use for subsettings the dataframe
#' @param template Path to .Rmd template
#' @param output_format Format to generate for the report
#'
#' @export
#'
#' @examples
#' Generate a report for the cars dataset
#' generate(cars)
#' 
#' # Generate a report for all columns containing "DALY" or "YLD"
#' generate(gbd2015, pattern = "DALY|YLD")
#' 
#' # Generate all possible formats
#' generate(gbd2015, output_format = "all")
generate <- function(df, pattern = NULL, template = NULL, output_format = "html_document") {
  
  if (output_format == "all" || output_format == "pdf_document") {
    # Disable scientific notation when generating a pdf document (R/latex bug)
    options(scipen=999)
  }
  
  if (!is.null(pattern)) {
    df <- df[grep(pattern, names(df), value = T)]
  }
  
  if (is.null(template)){
    template <- system.file("main.Rmd", package = "WizRd")
  } 
  
  rmarkdown::render(template,
         output_format = output_format,
         output_dir = getwd(),
         params = list(
            set_title = paste("Report for" , as.list(match.call())$df)
         )
   )
}