DefineBioticPSU: Biotic PSU

In StoXProject/RstoxBase: Base StoX Functions

Biotic PSU

Description

This function defines the BioticPSU process data, linking strata, biotic PSUs and Stations

Usage

DefineBioticPSU(
  processData,
  UseProcessData = FALSE,
  StratumPolygon,
  StoxBioticData,
  DefinitionMethod = c("Manual", "StationToPSU", "DeleteAllPSUs", "ResourceFile"),
  FileName = character()
)

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.
StratumPolygon	The StratumPolygon process data.
StoxBioticData	StoxBioticData (defined in RstoxData).
DefinitionMethod	Character: A string naming the method to use, one of "Manual" for manual tagging of stations to PSUs (not yet implemented); "StationToPSU", which sets each Station as a PSU; "DeleteAllPSUs" to delete all PSUs; and "ResourceFile" to read from a project.xml file from StoX <= 2.7. Note that in the latter case it is assumed that the contents of the project.xml file is actually used in the StoX <= 2.7 project, i.e. that Method = "UseProcessData" in DefineSweptAreaPSU().
FileName	The path to a resource file from which to read PSUs, in the case that DefinitionMethod is "ResourceFile". Currently, only a project.xml file from StoX 2.7 can be read. Must include file extension.

Value

An object of StoX data type BioticPSU.

See Also

Acousic PSUs are generated using DefineAcousticPSU. For the vertical resolution (Layer) see DefineBioticLayer and DefineAcousticLayer.

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