getParams: Returns a list with all parameters and functions

View source: R/model.R

getParamsR Documentation

Returns a list with all parameters and functions

Description

Given a Parameters object, it returns as a list all relevant parameters and corresponding functions like pdf and cdf.

Usage

getParams(p = new("Parameters"), FF = NULL, calcBRPs = FALSE,
  isSurvey = FALSE, optim.fmsy = FALSE, optim.fmsyr = FALSE,
  optim.Rrel = FALSE)

Arguments

p

A Parameters object

FF

Numeric. Fishing mortality. This argument is ignored if all optim.* are FALSE

calcBRPs

Boolean. If true, calculates biological reference points.

isSurvey

boolean, if TRUE a survey selectivity is used for the pdf

optim.fmsy

Logical.

optim.fmsyr

Logical.

optim.Rrel

Logical

Value

  • If optim.* are all FALSE, an invisible list, containing all model parameters, the cdf, the pdf functions. spawning stock biomass (SSB), yield. If calcBRPs is TRUE also Fmsy.

  • If optim.fmsy is TRUE, only the yield per Rmax is returned

  • If optim.fmsyr is TRUE, only the yield per recruit is returned

  • If optim.Rrel is TRUE, only the R/Rmax - 0.5 is returned

Author(s)

alko

See Also

parameters

Examples


 getParams()


alko989/s6model documentation built on Nov. 2, 2023, 10:04 p.m.