Learn R Programming

DLMtool (version 3.2.2)

Jplot: Joint probability plot

Description

Calculates and plots the joint probability of meeting all performance metrics simultaneously

Usage

Jplot(MSEobj, PLim = 0.8, YVar = c("LTY", "STY", "avgB_B0", "avgB_BMSY"), PMRefs = list(B_BMSY = 0.5, B_B0 = 0.2), UseMean = TRUE, lastYrs = 10, AvailMPs = NULL, XLim = NULL, ShowCols = TRUE, ShowLabs = FALSE, All = TRUE)

Arguments

MSEobj
An object of class MSE
PLim
Probability limit (acceptable risk threshold; e.g., 0.8 for 80 percent)
YVar
What to plot of the y-axis: choose from c("LTY", "STY", "avgB_B0", "avgB_BMSY")
PMRefs
List containing the reference limits for each metric
UseMean
Logical. Calculate mean (TRUE) or median (FALSE)
lastYrs
Last number of years in projection period to calculate summary statistics
AvailMPs
Optional character vector of available MPs (plotted in a different colour)
XLim
Optional limits for the x-axis
ShowCols
Logical. Show the background colours?
ShowLabs
Logical. Show the MP labels?
All
Logical. Plot all MPs (TRUE) or only those above the probability limit (PLim))?

Value

Invisibly returns data frame containing statistics shown in the plot