DefineBioticLayer: Define biotic Layer

In StoXProject/RstoxBase: Base StoX Functions

Define biotic Layer

Description

This function defines the BioticLayer process data, which sets the range intervals of the swetp-area layers used in biotic estimation models in StoX.

Usage

DefineBioticLayer(
  processData,
  UseProcessData = FALSE,
  StoxBioticData,
  DefinitionMethod = c("WaterColumn", "HighestResolution", "Resolution", "Table"),
  Resolution = double(),
  LayerTable = data.table::data.table()
)

Arguments

processData	The current data produced by a previous instance of the function.
UseProcessData	Logical: If TRUE use the existing function output in the process.
StoxBioticData	StoxBioticData (defined in RstoxData).
DefinitionMethod	Character: A string naming the method to use, one of "WaterColumn", to define one single for the entire water column; "HighestResolution", to use the maximum possible vertical resolution without intersecting hauls; "Resolution", which can be used to set a fixed layer thickness; and "Table" to provide the LayerTable.
Resolution	Numeric: A single numeric giving the thickness of the layers.
LayerTable	A table of Layer name, MinLayerDepth in meters and MaxLayerDepth in meters, defining the Layers.

Value

An object of StoX data type BioticLayer.

See Also

Acoustic Layers are generated using DefineAcousticLayer. For the horizontal resolution (Stratum/PSU) see DefineBioticPSU and DefineAcousticPSU.

StoXProject/RstoxBase documentation built on Nov. 6, 2024, noon