Plot Total Biomass at Age (BAA)

Plot Total Biomass at Age (BAA)

plot_biomass_at_age(
  dat,
  facet = NULL,
  unit_label = "mt",
  scale_amount = 1000,
  proportional = TRUE,
  interactive = FALSE,
  make_rda = FALSE,
  figures_dir = getwd()
)

Arguments

dat

A data frame returned from convert_output

facet

a string or vector of strings of column(s) that groups the data (e.g. "fleet", "sex", "area", etc.). Set facet = "none" to summarize the data in a single plot.

unit_label

units for abundance

scale_amount

A number describing how much to scale down the biomass at age. For example, scale_amount = 100 would scale down a value from 500,000 –> 5,000. This scale will be reflected in the legend label if proportion is set to FALSE.

proportional

Set size of points relative to z when TRUE, point size are relative to one another while when set to FALSE, point size is relative to z

interactive

TRUE/FALSE; indicate whether the environment in which the function is operating is interactive. This bypasses some options for filtering when preparing data for the plot. Default is FALSE.

make_rda

TRUE/FALSE; indicate whether to produce an .rda file containing a list with the figure/table, caption, and alternative text (if figure). If TRUE, the .rda will be exported to the folder indicated in the argument "rda_dir". Default is FALSE.

figures_dir

The location of the folder containing the generated .rda files ("rda_files") that will be created if the argument `make_rda` = TRUE. Default is the working directory.

Value

Plot total biomass at age from a stock assessment model as found in a NOAA stock assessment report. Units of total biomass can either be manually added or will be extracted from the provided file if possible.

Examples

plot_biomass_at_age(
  dat = stockplotr:::example_data,
  unit_label = "mt",
  scale_amount = 100,
  proportional = FALSE, # displays legend
  make_rda = FALSE
)
#> ! Multiple module names found in data. 
#> ℹ Environment not interactive. Selecting BIOMASS_AT_AGE.
#> Joining with `by = join_by(year, sex, growth_pattern)`

plot_biomass_at_age(
  dat = stockplotr:::example_data,
  unit_label = "mt",
  facet = "none",
  proportional = FALSE
)
#> ! Multiple module names found in data. 
#> ℹ Environment not interactive. Selecting BIOMASS_AT_AGE.
#> Joining with `by = join_by(year)`