DefineSurvey: Define Survey

DefineSurveyR Documentation

Define Survey

Description

This function defines the Strata associated to different surveys (in the sense that a separate estimate should be made for those strata).

Usage

DefineSurvey(
  processData,
  UseProcessData = FALSE,
  DefinitionMethod = c("AllStrata", "Table", "ResourceFile"),
  StratumPolygon,
  SurveyTable = data.table::data.table(),
  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.

DefinitionMethod

Character: A string naming the method to use, one of "AllStrata", which defines all strata as the same survey named "Survey"; "Table", which requires the SurveyTable to be given; and "ResourceFile" to read from a project.xml file from StoX 2.7.

StratumPolygon

The StratumPolygon process data.

SurveyTable

A table of the two columns Stratum and Survey.

FileName

The path to the StoX 2.7 project.xml file to read StratumPolygon from, in the case that DefinitionMethod is "ResourceFile".

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 July 14, 2024, 9:39 a.m.