checkFLBEIAData: Checking inputs of FLBEIA function

In flr/FLBEIA: Bio-Economic Impact Assessment of Management Strategies using FLR

Checking inputs of FLBEIA function

Description

This functions checks wether some conditions are met for the inputs in the different arguments of the FLBEIA function. There are also checking functions for specific inputs: biols, fleets, SRs, advice, and obs.ctrl arguments.

Functions available:

• checkFLBEIAData: for checking inputs for differents arguments of FLBEIA function (of class FLBiols).

• checkBiols: for checking biols argument of FLBEIA function (of class FLBiols).

• checkFleets: for checking fleets argument of FLBEIA function (of class FLFleetsExt).

• checkSRs: for checking SRs argument of FLBEIA function (list of FLSRsim objects).

• checkAdvice: for checking advice argument of FLBEIA function (of class list with two FLQuant elements, TAC and quota.share).

• checkObsctrl: for checking obs.ctrl argument of FLBEIA function (of class list).

Usage

checkFLBEIAData(
  biols,
  SRs = NULL,
  BDs = NULL,
  fleets,
  covars = NULL,
  indices = NULL,
  advice = NULL,
  main.ctrl,
  biols.ctrl,
  fleets.ctrl,
  covars.ctrl,
  obs.ctrl,
  assess.ctrl,
  advice.ctrl
)

checkBiols(object)

checkFleets(object, ctrl = NULL)

checkSRs(object)

checkBDs(object)

checkAdvice(object)

checkObsctrl(object)

Arguments

biols	An FLBiols object.
SRs	A list of FLSRsim objects.
BDs	A list of FLBDsim objects.
fleets	An FLFleetsExt object.
covars	A list of FLQuants.
indices	A list of FLIndices.
advice	A list with two FLQuant elements, TAC and quota.share.
main.ctrl	A list with the settings to control the main function.
biols.ctrl	A list with the settings to control the biological operating model for each stock.
fleets.ctrl	A list with the settings to control the fleets operating model for each fleet.
covars.ctrl	A list with the settings to control the covars operating model for each fleet.
obs.ctrl	A list with the settings to control the observation model for each stock.
assess.ctrl	A list with the settings to control the specify the assessment model for each stock.
advice.ctrl	A list with the settings to control the advice model for each stock.
object	An object of the appropiate class depending on the FLBEIA argument to be checked: biols : A FLBiols object. fleets :A FLFleetsExt object. SRs : A list of FLSRsim objects. BDs : A list of FLBDsim objects. advice : A list with two FLQuant elements, TAC and quota.share.. obs.ctrl: A list.
ctrl	An object of class list (optional argument), input for fleets.ctrl argument of FLBEIA function.

Value

An error message if there is any error detected.

flr/FLBEIA documentation built on Feb. 22, 2024, 1:36 a.m.