util_heatmap_1th: Utility Function Heatmap with 1 Threshold

In dataquieR: Data Quality in Epidemiological Research

Utility Function Heatmap with 1 Threshold

Description

Function to create heatmap-like plot given one threshold – works for percentages for now.

Usage

util_heatmap_1th(
  df,
  cat_vars,
  values,
  threshold,
  right_intv,
  invert,
  cols,
  strata
)

Arguments

df	data.frame with data to display as a heatmap.
cat_vars	variable list len=1-2. Variables to group by. Up to 2 group levels supported.
values	variable the name of the percentage variable
threshold	numeric lowest acceptable value
right_intv	logical len=1. If FALSE (default), intervals used to define color ranges in the heatmap are closed on the left side, if TRUE on the right side, respectively.
invert	logical len=1. If TRUE, high values are better, warning colors are used for low values. FALSE works vice versa.
cols	deprecated, ignored.
strata	variable optional, the name of a variable used for stratification inheritParams acc_distributions

Value

a list with:

• SummaryPlot: ggplot object with the heatmap

See Also

Other figure_functions: util_optimize_histogram_bins()

dataquieR documentation built on May 29, 2024, 7:18 a.m.