AddStratumStoxLanding: Adds Strata to StoxLandingData

View source: R/StoxBaselineFunctions.R

AddStratumStoxLandingR Documentation

Adds Strata to StoxLandingData

Description

Adds a column to StoxLandingData with the spatial strata each row belongs to.

Usage

AddStratumStoxLanding(
  StoxLandingData,
  StratumPolygon,
  ColumnName = character()
)

Arguments

StoxLandingData

StoxLandingData data which will be annotated. Needs postions appended. See details.

StratumPolygon

Definition of spatial strata. See StratumPolygon

ColumnName

specifies which column the area should be added to. See details. Defaults to Stratum.

Details

The strata are added to the new column specified by ColumName.

If 'ColumnName' is 'Area', The column 'Area' of StoxLandingData is overwritten. Other columns in StoxLandingData may not be specified.

StoxLandingData does not contain columns for positions, these need to be added as columns 'Latitude' and 'Longitude' before calling this function. AddAreaPositionStoxLanding may be used to append positions, based on area codes.

Value

StoxLandingData with column appended. See StoxLandingData.

See Also

DefineStratumPolygon for configuring stratum definitions. AddAreaPositionStoxLanding for adding positions to landings, AddStratumStoxBiotic for similar function for sample data, PrepareRecaEstimate for use of 'Stratum' as an effect in Reca-estimation, DefineCarNeighbours for obtaining a neighbour-definition for using 'Stratum' as CAR-effect in Reca-estimation. and ReportFdaSampling for use of 'Stratum' as an aggregation variable when comparing sampling with landed volume.


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