RapidRicker: RapidRicker

View source: R/FUNCTION_RapidRicker.R

RapidRickerR Documentation

RapidRicker

Description

This function is a wrapper for testDetRickerBM(). It loops throug multiple stocks and applies all the sensitivity test variations, then calculates the perc differences to base case. For calculation details, refer to calcDetRickerBM and testDetRickerBM.

Usage

RapidRicker(
  sr_obj_m,
  min.obs = 10,
  trace = TRUE,
  flags = NULL,
  data.check = TRUE,
  bm.test = TRUE,
  sr.scale = 10^6
)

Arguments

sr_obj_m

a data frame with Stock, Year and Spn, logRpS (Data for multiple stocks!). Other variables can be there but are not used (RpS, Qual, ExpF etc).

min.obs

min number of S-R pairs needed to fit a model

trace

if TRUE, print various intermediate diagnostic output to the console

flags

a data frame with Label, Lower, Upper. Lower and Upper define the triggers for values to be flagged. Labels have to match the criteria used in the function(LIST). If flags = NULL, then it uses the built-in object flags_default.

data.check

if TRUE, do the data check (either data.check or bm.test or both must be true!)

bm.test

if TRUE, do the benchmark sensitivity tests (either data.check or bm.test or both must be true!)

Examples

rapid.ricker.out <- RapidRicker(SR_Sample,min.obs = 10,  trace=FALSE)

SOLV-Code/RapidRicker documentation built on Jan. 14, 2025, 9:36 a.m.