plotCUTradeoff: CU-specific trade off plot

In CamFreshwater/samSim: Closed-loop salmon dynamics simulator

CU-specific trade off plot

Description

This function generates Kobe style plots for a series of conservation- and catch-based performance metrics.

Usage

plotCUTradeoff(
  cuDat,
  consVar = "medSpawners",
  catchVar = "medCatch",
  facet = "cu",
  panel = NULL,
  showUncertainty = FALSE,
  hotColors = TRUE,
  legendLab = NULL,
  xLab = NULL,
  yLab = NULL,
  main = TRUE,
  axisSize = 14,
  dotSize = 4,
  lineSize = 1.25,
  legendSize = 14,
  freeY = TRUE,
  scaleAxis = "free"
)

Arguments

cuDat	Dataframe generated by buildCUDat.
consVar	A character value corresponding to a conservation based PM in cuDat$vars.
catchVar	A character value corresponding to a catch based PM in cuDat$vars.
facet	A character value that can take the values: "cu", "mp", "om" and specifies along which categorical variable the plot should be faceted.
panel	A character value that can take the values: "mp", "om" and specifies along which categorical variable new pages in the output PDF will be generated.
showUncertainty	A logical specifying whether whiskers for each variable's credible interval should be plotted.
hotColors	A logical (default TRUE) that specifies whether symbols should be filled with viridis palette or grey scale.
legendLab	A character representing the legend title.
xLab	A character representing the x axis label.
yLab	A character representing the y axis label.
main	A logical specifying whether a plot title should be added.
scaleAxis	A character vector that can take values 'c("fixed", "free", "free_x", "free_y")' that determines which axes, if any, have variable axes dimensions across facets.

Value

Returns a ggplot object.

Examples

plotCUTradeoff(cuPlottingDF, consVar = "medSpawners", catchVar = "medCatch",
facet = "cu", panel = "om", showUncertainty = FALSE,
legendLab = "Prop. TAC in mixed stock fishery", xLab = "Median Catch",
yLab = "Median Spawners", main = FALSE)

CamFreshwater/samSim documentation built on Sept. 25, 2023, 10:22 a.m.