Skip to contents

Plot recruitment deviates

Source: R/recruitment.R
plot_rec_devs.Rd

Plot recruitment deviates by year.

Usage

plot_rec_devs(
  fit = NULL,
  object = NULL,
  proj = NULL,
  posterior = NULL,
  probs = c(0.025, 0.975),
  n_worms = 3L,
  data = NULL
)

Arguments

fit

An sbt_fit object. Its stored MCMC is used by default.

object

Legacy RTMB objective used only with a legacy data-list input.

proj

A list or NULL containing optional projection data with proj_rdev_y (default NULL).

posterior

A posterior object supported by SparseNUTS::extract_samples(), or NULL.

probs

Numeric vector of posterior probabilities in [0, 1].

n_worms

Integer number of randomly selected posterior trajectories. It must not exceed the number of available draws.

data

Legacy named alias for a model data list; supply object as well.

Value

A ggplot2 object showing recruitment deviates over time.

Details

Posterior and projection trajectories are selected after setting the global random-number seed to 42. The function does not restore the caller's previous random-number state.