get.tornado.table: Render a tornado table

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

Description

Render a tornado table

Usage

get.tornado.table(
  outcome.variable,
  parameters = parms.tried.df,
  outcomes = outcomes.summary.df,
  method = "kendall-partial-correlation-slow"
)

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").

Value

none.

Examples

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

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

get.tornado.table(
  outcome.variable = "maxInc",
  parameters = parameters.swept,
  outcomes = outcomes.summary.df
)

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