get.tornado.plot: Render a tornado plot

In StatCan/EpiSim: Build multi-compartment models via an Excel workbook

Description

Render a tornado plot

Usage

get.tornado.plot(
  outcome_variable,
  parameters = parms.tried.df,
  outcomes = outcomes.summary.df,
  method = "kendall-partial-correlation-slow",
  bin_width = 0.5,
  element_text_size = 12,
  order_by_absolute_value = FALSE,
  add_label = FALSE,
  height = NULL,
  width = NULL,
  parameter_labels = NULL
)

Arguments

outcome_variable	a character element.
parameters	the parms.tried.df data frame.
outcomes	the outcomes.summary.df data frame.
method	a character element ("kendall-partial-correlation-slow", "pearson-partial-correlation-fast", #' "pearson-partial-correlation-slow", "spearman-partial-correlation-slow", "negative-log-p-value", "t-test").
bin_width	a numeric element representing the width of the bars (by default, 0.5).
element_text_size	a numeric element (by default, 12).
order_by_absolute_value	a logical element representing whether to order the bars by absolute value (by default, FALSE).
add_label	a logical element representing whether to add labels to the bars (by default, FALSE).
height	an integer element representing the height of the plot in pixels.
width	an integer element representing the width of the plot in pixels.
parameter_labels	a character vector representing custom labels for all parameters.

Value

none.

Examples

# Load demo data
data("EpiSim.demo")

# Define results
parameters.swept <- EpiSim.demo$parameters
outcomes.summary.df <- EpiSim.demo$results

get.tornado.plot(
  outcome_variable = "maxInc",
  parameters = parameters.swept,
  outcomes = outcomes.summary.df,
  height = 500,
  width = 756
)

StatCan/EpiSim documentation built on Dec. 18, 2021, 2:09 p.m.