plotLargeScaleCharacteristics {CohortCharacteristics}

create a ggplot from the output of summariseLargeScaleCharacteristics.

Description

'r lifecycle::badge("experimental")'

Usage

plotLargeScaleCharacteristics(
  data,
  position = "horizontal",
  splitStrata = FALSE,
  facet = NULL,
  colorVars = "variable_level"
)

Arguments

data

output of summariseLargeScaleCharacteristics().

position

if set to *horizontal* the horizontal axis will plot "variable_name" column and the vertical axis "estimate_value" column. If *vertical*, axis will be the other way around.

splitStrata

boolean variable (TRUE/FALSE)

facet

columns in data to facet. If the facet position wants to be specified, use the formula class for the input (e.g., strata + table_name ~ group_level + cdm_name). Variables before "~" will be facet by on horizontal axis, whereas those after "~" on vertical axis. Character format is also allowed (e.g., c("strata","table_name","group_level","cdm_name")). Only the following columns are allowed to be facet by: c("cdm_name", "group_level", "strata_level", "variable_level", "strata", "table_name"). If splitStrata = TRUE, strata levels are also allowed.

colorVars

column in data to color by. Only the following columns are allowed to be used: c("cdm_name", "group_level", "strata_level", "variable_level", "strata", "table_name"). If splitStrata = TRUE, strata levels are also allowed.

Value

A ggplot.