diamondplot: Diamond plots of MSE output

View source: R/plot.R

diamondplotR Documentation

Diamond plots of MSE output

Description

Diamond plots of MSE output

Usage

diamondplot(x, what, ylab = what, xlab = "Management Procedure",
  hline = NULL, area = NULL, year, IE = NULL, IEnames = NULL,
  legnames = NULL, threshold = NULL, data = FALSE, ratio = FALSE,
  OMtype = FALSE)

## S3 method for class 'ccamforecast'
diamondplot(x, ...)

## S3 method for class 'forecastset'
diamondplot(x, what, ylab = what,
  xlab = "Management Procedure", hline = NULL, area = NULL,
  year = "all", IE = NULL, IEnames = NULL, legnames = NULL,
  threshold = NULL, data = FALSE, ratio = FALSE, OMtype = FALSE)

Arguments

x

the object(s) returned from ccam.forecast

what

statistic returned from ccam.forecast

ylab

y label

xlab

x label

hline

plot horizontal line(s)

area

color plot underneath this yintercept

year

year for which the statistics needs to be plotted

  • NULL Takes median all years

  • 'numeric vector' Takes median of specified years

  • 'threshold' Takes year at which threshold is reached (see threshold param)

  • 'percyear' Takes percentage of years where threshold is reached (see threshold param)

  • 'zone' Makes a facet grid in which the statistic is grouped by zone (critical, healthy or cautious)

IE

Which IE to plot (if vector)? Defaults to collapsed IE. Can be numeric or string (grep).

IEnames

character string containing alternative names for the IEs

legnames

character string containing alternative names for the legend (OM types)

threshold

if year=TRUE than a threshold can be specified and the year at which it is reached becomes the y value for 'what'

data

logical. return data instead of plot.

ratio

logical. devide by LRP?

OMtype

logical. OMbase/core/whatever present?

Details

performance (what) by management procedure, IE and OM type. OM type is defined by the OM name (numbers and 'OM' are removed).


elisvb/CCAM documentation built on March 13, 2023, 6:55 a.m.