makeRectRegion: Make a rectangular Echoview region (EVR) file.

In AustralianAntarcticDivision/EchoviewR: Control of Echoview via COM

Make a rectangular Echoview region (EVR) file.

Description

This function creates a rectangular (2D) Echoview region file. The function can add regions to an existing EVR file.

Usage

makeRectRegion(
  dateStart,
  timeStart,
  dateStop,
  timeStop,
  minDepth = 0,
  maxDepth,
  outPathFn,
  regionClassName,
  regionType,
  append = FALSE,
  exactRegionName = NULL
)

Arguments

dateStart	date stamp for the start of the region (yyymmdd)
timeStart	time stamp for the start of the region (hhmmss)
dateStop	date stamp for the end of the region (yyymmdd)
timeStop	time stamp for the end of the region (hhmmss)
minDepth	=0 Minimum depth for the region
maxDepth	maximum depth for the region
outPathFn	output parth and filename.
regionClassName	region class name
regionType	region Type (integer)
append	= FALSE should be region be added to the EVR file given in outPathFn
exactRegionName	= NULL exact region name (no integer increment will be applied)

Details

Region types supported by Echoview: 0 = bad (no data); 1 = analysis; "2" = marker; 3 = fishtracks, and 4 = bad (empty water)

Value

list: $msg messages from the function call $exportFLAG Boolean TRUE EVR file created or added. FALSE otherwise

References

http://support.echoview.com/WebHelp/Echoview.htm/

Examples

## Not run: makeRectRegion(dateStart='20170815',timeStart='001525',
dateStop='20170815',timeStop='001738', 
minDepth=20,maxDepth=100,
outPathFn='~/test2.evr',
regionClassName='ctd',append=FALSE)
## End(Not run)

AustralianAntarcticDivision/EchoviewR documentation built on Aug. 21, 2023, 6:56 p.m.