Create overview or provider report

This function creates a report for "Overview", or for a provider "Anglicare", "BaptistCare" or "Scalabrini". It can also optionally create the accommpanying facilities report with make_report("Anglicare", facility_report=TRUE)

Usage

make_report(
  provider,
  optimize = TRUE,
  supplement = FALSE,
  presentation_figures = FALSE,
  config_file = "report_settings.yaml",
  figure_settings_file = "figure_settings.yaml",
  template_dir = "templates/template-files",
  static_image_dir = "templates/static-images",
  data_dir = "templates/extra_data"
)

Arguments

provider

The provider report to create (Anglicare, BaptistCare, or Scalabrini), or "Overview"

optimize

Should the PDF be optimized (default TRUE)

presentation_figures

A logical value (defaults to FALSE). If TRUE, the function will create additional figures to be used in the presentation at the Roundtable meeting.

config_file

A character string specifying the path to the YAML configuration file (defaults to "report_settings.yaml"). #' @param figure_settings_file A character string specifying the path to the YAML file containing settings and specifications for figures (defaults to "figure_settings.yaml").

template_dir

A character string specifying the directory where report templates and related files are located (defaults to "templates/template-files").

static_image_dir

A character string specifying the directory where static images to be included in the report are stored (defaults to "templates/static-images").

data_dir

A character string specifying the directory containing additional data files that might be used in report generation (defaults to "templates/extra_data").

facility_report

A logical value (defaults to FALSE). If TRUE, the function will produce the accompanying facilities report.

Value

TRUE if report created successfully, otherwise FALSE

Examples

if (FALSE) { # \dontrun{
# Create overview report
make_report("Overview")

# Create main report for Anglicare
make_report("Anglicare")

# Create both main report and facilities report for BaptistCare
make_report("BaptistCare", facility_report = TRUE)

# Create the overview and figures for the presentation
make_report("Overview", presentation_figures=TRUE)
} # }