AddGearGroupStoxBiotic: Add Gear group to StoxBioticData

View source: R/StoxBaselineFunctions.R

AddGearGroupStoxBioticR Documentation

Add Gear group to StoxBioticData

Description

Adds a column to StoxBioticData with gear groups

Usage

AddGearGroupStoxBiotic(StoxBioticData, Translation)

Arguments

StoxBioticData

StoxBioticData data which will be annotated.

Translation

Translation table (Translation). See details.

Details

Gear groups are defined as translations from a gear code to a gear group. Translation need to be defined for the VariableName 'Gear' (see Translation). The provided Translation should map values ('Gear' in Translation) for the variable 'Gear'on the table 'Haul' in 'StoxBioticData' to a gear group ('NewValue' in Translation). The gear group will be added to 'StoxBioticData' as the column 'GearGroup'

For comparison or co-analysis with landing data, a Translation should be defined for StoxLandingData with the same gear groups.

Value

StoxBioticData with column 'GearGroup' appended. See StoxBioticData.

See Also

DefineTranslation for configuring translation to gear groups, AddGearGroupStoxLanding for similar function for landing data, PrepareRecaEstimate for use of 'GearGroup' as an effect in Reca-estimation, and ReportFdaSampling for use of 'GearGroup' as an aggregation variable when comparing sampling with landed volume.


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