inputList_EffortData: Create an input list for effort data

View source: R/writeFunctions.R

inputList_EffortDataR Documentation

Create an input list for effort data

Description

Function to create an input list for effort data.

Usage

inputList_EffortData(
  dfr = NULL,
  avgInterval = "[1992:-1]",
  likeType = c("NORM2", "NORMAL", "LOGNORMAL"),
  likeWgt = 1,
  unitsIn = c("ONES", "MILLIONS"),
  unitsOut = c("MILLIONS", "ONES")
)

Arguments

dfr

: effort data dataframe

avgInterval

: averaging interval (e.g., [1992:-1])

likeType

: likelihood type ("NORM2","NORMAL",or "LOGNORMAL")

likeWgt

: likelihood weight (multiplier)

unitsIn

: input effort units ("ONES","MILLIONS")

unitsOut

: output effort units ("ONES","MILLIONS")

Details

See below:

The input dataframe dfr should have the following column names

  • year

  • effort

The output list has elements:

  • dfr - dataframe with columns 'year' and 'effort'

  • avgInterval - averaging interval given in TCSAM02 time block format

  • likeType - likelihood type

  • likeWgt - likelihood weight

  • unitsIn - units for input effort

  • unitsOut - units for output effort

Value

a list (see Details).


wStockhausen/tcsamFunctions documentation built on Jan. 28, 2024, 9:01 a.m.