Add Period to StoxBioticData

Add a column 'Period' to 'Station' on StoxBioticData with a temporal category, such as 'quarter'.

Usage

AddPeriodStoxBiotic(
  StoxBioticData,
  TemporalDefinition,
  ColumnName = character()
)

Arguments

StoxBioticData

StoxLandingData data which will be annotated with period.

TemporalDefinition

TemporalDefinition definition of temporal category.

ColumnName

specifies which column the area should be added to. Defaults to r RstoxFDA::stoxFunctionAttributes$AddPeriodStoxBiotic$functionParameterDefaults$ColumnName.

Value

StoxBioticData with column appended. See StoxBioticData. DefinePeriod for configuring the temporal definition, AddStratumStoxLanding for similar function for landing data, PrepareRecaEstimate for use of 'Period' as an effect in Reca-estimation, and ReportFdaSampling for use of 'Period' as an aggregation variable when comparing sampling with landed volume.

Details

'Period' will be added based on the column 'DateTime' on the table 'Station' in 'StoxBioticData'.

Temporal definitions (TemporalDefinition) may be produced by DefinePeriod