plotTornado: plotTornado

View source: R/FUNCTION_PlotTornado.R

plotTornadoR Documentation

plotTornado

Description

This function generates a plot showing a range for each row. Typically each row is a stock, the first col is a stock label, and the remaining columns have values for lower, mid, and upper (e.g. from a sensitivity test)

Usage

plotTornado(
  data.df,
  add.pt = FALSE,
  keep.rank = FALSE,
  add.labels = TRUE,
  xlim = NULL,
  solid.refline = NULL,
  dashed.refline = NULL
)

Arguments

data.df

a data frame with columns Label, Lower, Mid, Upper

add.pt

if = TRUE, data.df needs another column called AddPt with values for an additional point to be plotted

add.labels

if = TRUE, data.df needs another column called AddLabel which is added to the plot a labels inside the label axis (e.g. Avg abd as context)

rank

default rank is based on range between Upper and Lower. if keep.rank = TRUE, then keep the input order as is.


SOLV-Code/RapidRicker documentation built on Jan. 14, 2025, 9:36 a.m.