Skip to contents

Plotting outputs

Source: R/ArraySpeciesBySize-class.R, R/ArraySpeciesByTime-class.R
plot.Rd

Many mizer functions return values that depend on species and either size or time. plot() creates a ggplot2 figure with one line for each species showing the values against size or against time (depending on the type of output). ggplotly() creates an interactive version of the same figure.

Usage

# S3 method for class 'ArraySpeciesBySize'
plot(
  x,
  species = NULL,
  all.sizes = FALSE,
  highlight = NULL,
  return_data = FALSE,
  log_x = TRUE,
  log_y = FALSE,
  wlim = c(NA, NA),
  ylim = c(NA, NA),
  total = FALSE,
  background = TRUE,
  y_ticks = 6,
  ...
)

# S3 method for class 'ArraySpeciesBySize'
ggplotly(x, ...)

# S3 method for class 'ArraySpeciesByTime'
plot(
  x,
  species = NULL,
  start_time = NULL,
  end_time = NULL,
  y_ticks = 6,
  ylim = c(NA, NA),
  total = FALSE,
  background = TRUE,
  highlight = NULL,
  log_y = TRUE,
  return_data = FALSE,
  ...
)

# S3 method for class 'ArraySpeciesByTime'
ggplotly(x, ...)

Arguments

x

An ArraySpeciesBySize or ArraySpeciesByTime object.

species

Character vector of species to include. NULL (default) means all species.

all.sizes

If FALSE (default), values outside a species' size range (w_min to w_max) are removed. Only applies to ArraySpeciesBySize.

highlight

Name or vector of names of the species to be highlighted.

return_data

If TRUE, return the data frame instead of the plot.

log_x

If TRUE (default), use a log10 x-axis. Only applies to ArraySpeciesBySize.

log_y

If TRUE, use a log10 y-axis. Default is FALSE for ArraySpeciesBySize and TRUE for ArraySpeciesByTime.

wlim

A numeric vector of length two providing lower and upper limits for the weight (x) axis. Use NA to refer to the existing minimum or maximum. Only applies to ArraySpeciesBySize.

ylim

A numeric vector of length two providing lower and upper limits for the value (y) axis. Use NA to refer to the existing minimum or maximum.

total

A boolean value that determines whether the total over all selected species is plotted as well. Default is FALSE.

background

A boolean value that determines whether background species are included. Ignored if the model does not contain background species. Default is TRUE.

y_ticks

The approximate number of ticks desired on the y axis.

...

Further arguments (currently unused).

start_time

The first time to be plotted. Default (NULL) is the beginning of the time series. Only applies to ArraySpeciesByTime.

end_time

The last time to be plotted. Default (NULL) is the end of the time series. Only applies to ArraySpeciesByTime.

Value

plot() returns a ggplot2 object, unless return_data = TRUE, in which case a data frame is returned.

ggplotly() returns a plotly object.

Details

This works because the mizer functions that give values that depend on species and size return an ArraySpeciesBySize object and those that give values that depend on species and time return an ArraySpeciesByTime object. These objects have attributes that store the name of the value, its units, and a reference to the MizerParams object that the value was computed from. This allows the plots to be automatically labelled and coloured appropriately.

See also

Other plotting functions: animateSpectra(), plotBiomass(), plotDiet(), plotFMort(), plotFeedingLevel(), plotGrowthCurves(), plotMizerParams, plotMizerSim, plotPredMort(), plotSpectra(), plotYield(), plotYieldGear(), plotting_functions

Examples

# \donttest{
plot(getEncounter(NS_params))

plot(getFeedingLevel(NS_params), species = c("Cod", "Herring"))

# }
# \donttest{
ggplotly(getEncounter(NS_params))


# }
# \donttest{
plot(getBiomass(NS_sim))

plot(getBiomass(NS_sim), species = c("Cod", "Herring"), total = TRUE)

plot(getYield(NS_sim), species = c("Cod", "Herring"))

# }
# \donttest{
ggplotly(getBiomass(NS_sim))


# }