calc_fp: (FP) Calculate fisheries policy (FP) scaler.

In MichaelFolkes/ctctools: Analytical tools For The Pacific Salmon Commission's Chinook Technical Committee.

Description

(FP) Calculate fisheries policy (FP) scaler.

Usage

calc_fp(dat.er.long, dat.mdl.long, dat.spfi, allowMissingStocks = FALSE)

Arguments

dat.er.long	Data frame returned by read_stkfile.
dat.mdl.long	Data frame returned by read_mdl.
dat.spfi	Data frame in long format with same structure as the element S.ty, which is output of calc_SPFI.
allowMissingStocks	A Boolean. The stocks available in the .stk file should have a matching MDL file. The function will always check for missing stocks and throw a warning if MDL stocks are missing. If this is set to FALSE the calculation stops when stocks are missing. If this is set to TRUE, the function proceeds without the missing stocks. Default is FALSE.

Value

A list of two data frames. First data frame comprising the FP values. Second data frame consists of the intermediate calculated fields.

Examples

## Not run: 
dat.fp <- calc_fp(dat.er.long = dat.er.long.sub,
  dat.mdl.long = dat.mdl.long.sub, dat.spfi = dat.spfi.long)


## End(Not run)

MichaelFolkes/ctctools documentation built on May 7, 2019, 4:56 p.m.