AddGearGroupStoxLanding: Add Gear group to StoxLandingData

View source: R/StoxBaselineFunctions.R

AddGearGroupStoxLandingR Documentation

Add Gear group to StoxLandingData

Description

Adds a column to StoxLandingData with gear groups

Usage

AddGearGroupStoxLanding(StoxLandingData, Translation)

Arguments

StoxLandingData

StoxLandingData 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' in 'StoxBioticData' to a gear group ('NewValue' in Translation). The gear group will be added to 'StoxLandingData' as the column 'GearGroup'

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

Value

StoxLandingData with column 'GearGroup' appended.

See Also

DefineTranslation for configuring translation to gear groups, AddGearGroupStoxBiotic for similar function for sample 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 Nov. 12, 2024, 3:42 a.m.