Plot yield minus discards — plotYieldMinusDiscards • mizerShelf

Plot yield minus discards

Usage

plotYieldMinusDiscards(
  sim,
  sim2,
  species = NULL,
  total = FALSE,
  log = TRUE,
  highlight = NULL,
  return_data = FALSE,
  ...
)

Arguments

sim: An Sim object.
sim2: Optional second Sim object.
species: Species to plot.
total: Logical; should total yield be included in plot?
log: Logical; should the y-axis be log-transformed?
highlight: Name of species to highlight in plot.
return_data: Logical; should the underlying data be returned?
...: Other arguments passed to getYield.

Value

If return_data = TRUE, a data frame of the underlying data is returned.

Examples

plotYieldMinusDiscards(sim_instance)
#> Error in eval(expr, envir, enclos): object 'sim_instance' not found