writeInputFile_FleetData: Write fleet data (fishery or survey) to a TCSAM input file

View source: R/writeInputFile_FleetData.R

writeInputFile_FleetDataR Documentation

Write fleet data (fishery or survey) to a TCSAM input file

Description

Function to write fleet data to a TCSAM input file.

Usage

writeInputFile_FleetData(
  con = stdout(),
  fleet = NULL,
  type = c("FISHERY", "SURVEY"),
  closed = NULL,
  lstRC = NULL,
  lstTC = NULL,
  lstDC = NULL,
  lstIC = NULL,
  lstEff = NULL
)

Arguments

con

: connection to write to

fleet

: TCSAM fleet name

type

: fleet type ('FISHERY' or 'SURVEY')

closed

: vector of years when fishery was closed, if fleet is a fishery

lstRC

: list with retained catch information (see Details)

lstTC

: list with total catch information (see Details)

lstDC

: list with discard catch information (see Details)

lstIC

: list with index catch information (see Details)

lstEff

: list with effort data information

Details

Writes fleet-specific data file in TCSAM02 format.

The input lists lstRC, lstTC, lstDC, and lstIC must have the following structure, if not NULL:

  • lstAbd - NULL, or the lstAbd input to writeTCSAM02_CatchData() (see inputList_AggregateCatchData())

  • lstBio - NULL, or the lstAbd input to writeTCSAM02_CatchData() (see inputList_AggregateCatchData())

  • lstZCs - NULL, or the lstAbd input to writeTCSAM02_CatchData() (see inputList_SizeCompsData())

lstEff contains input values passed to writeTCSAM02_EffortData() and must have the following structure (inputList_EffortData()), if not NULL:

  • 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

Invisibly returns the connection to facilitate piping.

See Also

inputList_AggregateCatchData(), inputList_SizeCompsData(), inputList_EffortData().


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