AddPeriodStoxBiotic: Add Period to StoxBioticData
In StoXProject/RstoxFDA: Fisheries Dependent Analysis with RstoX

AddPeriodStoxBiotic

R Documentation

Add Period to StoxBioticData

Description

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 Period.

Details

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

Temporal definitions (TemporalDefinition) may be produced by DefinePeriod

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.

StoXProject/RstoxFDA documentation built on Jan. 13, 2024, 12:32 a.m.