plot.comparisons: Wrapper function for plotting model comparisons

Description Usage Arguments

View source: R/plot.comparisons.r

Description

Wrapper function for plotting model comparisons

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
plot.comparisons(
  rep.list,
  frq.list,
  par.list,
  model.names,
  agg.years = TRUE,
  agg.regions = TRUE,
  biomass.type = "SSB",
  biomass.units = 1000,
  fisheries.edev = NULL,
  recdist.year_range = NULL,
  yaxis.free = FALSE,
  LRP = NULL,
  TRP = NULL,
  palette.func = default.model.colours,
  save.dir,
  save.name,
  ...
)

Arguments

rep.list

A list of MFCLRep objects. The reference model should be listed first.

frq.list

A list of MFCLFrq objects

par.list

A list of MFCLPar objects

model.names

A vector of character strings naming the models for plotting purposes

agg.years

TRUE or FALSE. Should model outputs be aggregated to an annual time step.

agg.regions

TRUE or FALSE. Should model outputs be aggregated across all regions are kept separate.

biomass.type

Character string denoting the type of biomass plotted, 'SSB' or 'Total'

biomass.units

Integer number denoting how many MT to divide the biomass by. Default is 1000.

fisheries.edev

A vector of fishery indices to plot for the effort devs

recdist.year_range

The year range to average the total recruitment over. Default is the last 10 years.

yaxis.free

TRUE or FALSE. Default is FALSE. If TRUE and agg.regions is also TRUE than the y-axis scales will be independent across regions, otherwise they will be shared so regional scaling will be apparent.

LRP

Limit reference point. If not specified it is not plotted.

TRP

Target reference point. If not specified it is not plotted.

palette.func

A function to determine the colours of the models. The default palette has the reference model in black. It is possible to determine your own palette function. Two functions currently exist: default.model.colours() and colourblind.model.colours().

save.dir

Path to the directory where the outputs will be saved

save.name

Name stem for the output, useful when saving many model outputs in the same directory

...

Passes extra arguments to the palette function. Use the argument all.model.colours to ensure consistency of model colours when plotting a subset of models.


PacificCommunity/ofp-sam-diags4MFCL documentation built on July 18, 2021, 9:25 a.m.