render_example_report: render_example_report

In HorridTom/hospitalflow: Analysis of Patient Flow in Hospitals

render_example_report

Description

render_example_report

Usage

render_example_report(
  title = "Example Hospital Flow Report",
  author = "ARC NWL Information Intelligence Team",
  hospital_name = "Anytown General Hospital",
  use_example_data = TRUE,
  sample_weeks = 20,
  sample_no_of_patients = NULL,
  import_list_path = system.file("extdata", "example-config",
    "example_import_list.rds", package = "hospitalflow"),
  output_dir,
  use_existing_spell_table = TRUE,
  existing_spell_table_path = NULL,
  existing_moves_table_path = NULL
)

Arguments

title	The title to use for the report.
author	The author to be named on the report.
hospital_name	The hospital name to use for the report and all graphs.
use_example_data	If TRUE, use the package example data.
sample_weeks	The number of weeks of sample data to use for the report.
import_list_path	The directory containing the import list as an RDS file. Ignored if use_example_data is TRUE.
output_dir	The directory where the report will be saved.
use_existing_spell_table	If TRUE, skip import_standardise_bind and just load a spell table and a moves table directly. If use_example_data is also TRUE, uses the example spell table provided in the package.
existing_spell_table_path	path to existing spell table. Ignored if use_existing_spell_table is FALSE or use_example_data is TRUE.
existing_moves_table_path	path to existing moves table. Ignored if use_existing_spell_table is FALSE or use_example_data is TRUE.
sample_no_patients	The number of patients in the sample data to use for the report.

Value

The system.time output for the time taken to render the report.

Examples

## Not run: 
render_example_report(output_dir = "../reports", use_existing_spell_table = FALSE)
render_example_report(output_dir = "../reports", use_existing_spell_table = TRUE)

## End(Not run)

HorridTom/hospitalflow documentation built on June 14, 2022, noon