DefineWeightConversionFactor: Define Weight Conversion Factors

In StoXProject/RstoxFDA: Fisheries Dependent Analysis with RstoX

Define Weight Conversion Factors

Description

Define weight conversion factors for calculating approximate weights for a product type (e.g. round fish) from the weight of other fish products, such as gutted fish.

Usage

DefineWeightConversionFactor(
  processData,
  DefinitionMethod = c("ResourceFile", "FDIR.VIII.2022"),
  FileName = character(),
  UseProcessData = F
)

Arguments

processData	WeightConversionTable as returned from this function
DefinitionMethod	'ResourceFile' or 'FDIR.VIII.2022'. See details.
FileName	path to resource file
UseProcessData	If TRUE, bypasses execution of function and returns existing 'processData'

Details

For DefinitionMethod 'ResourceFile': Definitions are read from a tab separated, UTF-8 encoded file with headers. Columns defined as:

Column 1: 'Description'

Free-text description of the product

Column 2: 'Species'

Identifier for the species that the conversion applies to

Column 3: 'ProductType'

Identifier for the type of product that the conversion applies to

Column 4: 'WeightFactor'

scalar value that weights for the given 'ProductType' can be multiplied with to approximate the desired product type (w.g. round fish).

For DefinitionMethod 'FDIR.VIII.2022', the table FDIR.factors.VIII.2022 will be used

Missing values for WeightFactor are interpreted as NA, and will result in NA for weights after conversion.

Value

WeightConversionTable

See Also

ConvertWeightBiotic for applying weight conversion to data.

StoXProject/RstoxFDA documentation built on Dec. 17, 2024, 10:58 a.m.