Skip to contents

[Experimental] Plots the proportions with which each prey species contributes to the total biomass consumed by the specified predator species, as a function of the predator's size. These proportions are obtained with getDiet().

Usage

plotDiet(object, species = NULL, return_data = FALSE)

Arguments

object

An object of class MizerSim or MizerParams.

species

The species to be selected. Optional. By default all target species are selected. A vector of species names, or a numeric vector with the species indices, or a logical vector indicating for each species whether it is to be selected (TRUE) or not.

return_data

A boolean value that determines whether the formatted data used for the plot is returned instead of the plot itself. Default value is FALSE

Value

A ggplot2 object, unless return_data = TRUE, in which case a data frame with the four variables 'Predator', 'w', 'Proportion', 'Prey' is returned.

Details

Prey species that contribute less than 1 permille to the diet are suppressed in the plot.

If more than one predator species is selected, then the plot contains one facet for each species.

Examples

# \donttest{
plotDiet(NS_params, species = "Cod")

plotDiet(NS_params, species = 5:9)


# Returning the data frame
fr <- plotDiet(NS_params, species = "Cod", return_data = TRUE)
str(fr)
#> 'data.frame':	812 obs. of  4 variables:
#>  $ Predator  : Factor w/ 1 level "Cod": 1 1 1 1 1 1 1 1 1 1 ...
#>  $ w         : num  0.486 0.58 0.693 0.827 0.987 1.18 1.4 1.68 2 2.39 ...
#>  $ Prey      : Factor w/ 13 levels "Resource","Saithe",..: 13 13 13 13 13 13 13 13 13 13 ...
#>  $ Proportion: num  0.00113 0.00139 0.0017 0.00208 0.00254 ...
# }