make_heatcal: Make a heat_cal object

Description Usage Arguments Value

View source: R/calendar_heat.R

Description

Make a heat_cal object

Usage

1
2
3
4
5
6
7
make_heatcal(
  reference_tbl = NULL,
  dataitem_tbl = NULL,
  site = NULL,
  date_boundaries = NULL,
  max_limit = NULL
)

Arguments

reference_tbl

reference table produced from make_reference

dataitem_tbl

an extracted dataitem from extract

site

character string of hospital site to plot

date_boundaries

character vector of format YYYY-MM-DD (or something that is parsable by lubridate::ymd) defining the start and end dates of the calendar. If nothing is supplied, this is derrived from the data

max_limit

the upper bound for determining colour scale. This is useful if you have extreme outliers to enable good constrast over the range of interest

Value

an object of class heat_cal. Returns 'FALSE' if the site is not found in the data


CC-HIC/inspectEHR documentation built on Jan. 16, 2020, 11:24 p.m.