plot_assessment_history_disp: Create Interquartile range or quartile coefficient of...

View source: R/plot-assessment-history-disp.R

plot_assessment_history_dispR Documentation

Create Interquartile range or quartile coefficient of dispersion plots for the assessment history spawning biomass estimates

Description

Create Interquartile range or quartile coefficient of dispersion plots for the assessment history spawning biomass estimates

Usage

plot_assessment_history_disp(
  model,
  type = c("inter", "coeff"),
  y_lim = c(0, 2000),
  x_breaks = seq(start_yr, end_yr, 2),
  point_shape = ts_pointshape,
  point_size = ts_pointsize,
  point_color = ts_single_model_pointcolor,
  line_width = ts_linewidth,
  line_color = ts_single_line_color,
  line_type = ts_single_model_linetype,
  ...
)

Arguments

model

A model object, created by create_rds_file()

type

One of 'inter' or 'coeff' for Inter-quartile range or Quartile coefficient of dispersion respectively

x_breaks

A vector of the values to show on the x-axis. The defaults start_yr and end_yr are assigned in the first few lines of the function to be the limits of the data

point_shape

A numeric point shape code

point_size

Size of the points

point_color

Color of the points

line_width

Width of the line

line_color

Color of the line

line_type

Type of the line, e.g. "dashed", "solid", "dotted"

...

Arguments to pass to calc_retro_stats() (namely, yr)

ylim

A vector of two representing the minimum and maximum values to show on the y-axis

Details

Note that if you expect this function to work correctly outside of the hake repository directories (e.g. in a testing directory you got to by running gotest()), you must supply the full-path filename for the 'assessment-history-dispersion.csv' file using the arg fn to this function. It will be passed via ... to calc_retro_stats().

Value

a ggplot2::ggplot() object


pacific-hake/hake-assessment documentation built on Jan. 14, 2025, 9:12 p.m.