Skip to contents

Get the standardised indices each year with associated uncertainty and return either as a table or a ggplot.

Usage

get_index(
  fit,
  year = "year",
  probs = c(0.025, 0.975),
  rescale = 1,
  do_plot = FALSE,
  ...
)

Arguments

fit

An object of class brmsfit.

year

The year or time label (e.g. year, Year, fishing_year, etc).

probs

The percentiles to be computed by the quantile function.

rescale

How to re-scale the series. Choose from "raw" to retain the raw series, "unstandardised" to re-scale to the geometric mean of the unstandardised series, or a number to re-scale by.

do_plot

Return a ggplot object instead of a data.frame.

...

Additional parameters passed to fitted.

Value

a data.frame or a ggplot object.

Author

Darcy Webber darcy@quantifish.co.nz