DefineStockSplittingParameters: Define Stock Splitting Parameters

In StoXProject/RstoxFDA: Fisheries Dependent Analysis with RstoX

Define Stock Splitting Parameters

Description

Defines parameters for the stock-splitting analysis in Reca, including parameters for misclassifying when determining stock membership of a specimen.

Usage

DefineStockSplittingParameters(
  processData,
  DefinitionMethod = c("ResourceFile", "FunctionParameters"),
  FileName = character(),
  StockNameCC = character(),
  StockNameS = character(),
  ProbabilityType1As1 = numeric(),
  ProbabilityType5As1 = numeric(),
  ProbabilityType2As2 = numeric(),
  ProbabilityType4As2 = numeric(),
  ProbabilityType2As4 = numeric(),
  ProbabilityType4As4 = numeric(),
  ProbabilityType1As5 = numeric(),
  ProbabilityType5As5 = numeric(),
  UseProcessData = F
)

Arguments

processData	data.table() as returned from this function
DefinitionMethod	'ResourceFile' or 'FunctionParameters', see details.
FileName	path to resource file
StockNameCC	Variable for StockSplittingParameters
StockNameS	Variable for StockSplittingParameters
ProbabilityType1As1	Variable for StockSplittingParameters
ProbabilityType5As1	Variable for StockSplittingParameters
ProbabilityType2As2	Variable for StockSplittingParameters
ProbabilityType4As2	Variable for StockSplittingParameters
ProbabilityType2As4	Variable for StockSplittingParameters
ProbabilityType4As4	Variable for StockSplittingParameters
ProbabilityType1As5	Variable for StockSplittingParameters
ProbabilityType5As5	Variable for StockSplittingParameters
UseProcessData	If TRUE, bypasses execution of function and returns existing 'processData'

Details

For DefinitionMethod 'ResourceFile', definitions are read from a UTF-8 encoded tab separated file with headers and one row with headers corresponding to column names in StockSplittingParameters. see StockSplittingParameters for further explanation on the coding system.

For DefinitionMethod 'FunctionParameters' defintions are constructed from parameters to this function.

Value

StockSplittingParameters.

See Also

PrepareRecaEstimate for use of stock-splitting parameters in Reca-estimation.

StoXProject/RstoxFDA documentation built on Nov. 12, 2024, 3:42 a.m.