dot-validate {PBSmapping} | R Documentation |
Validate PBSmapping Data Structures
Description
Routines to validate data structures (e.g., required field names, attributes) that are passed to package functions.
Usage
.validateData(data, className, requiredCols=NULL, requiredAttr=NULL,
noFactorCols=NULL, noNACols=NULL, keyCols=NULL, numericCols=NULL)
.validateEventData(EventData)
.validateLocationSet(LocationSet)
.validatePolyData(PolyData)
.validatePolyProps(polyProps, parCols=NULL)
.validatePolySet(polys)
.validateXYData(xyData)
Arguments
data |
|
className |
|
requiredCols |
|
requiredAttr |
|
noFactorCols |
|
noNACols |
|
keyCols |
|
numericCols |
|
EventData |
|
LocationSet |
|
PolyData |
|
polyProps |
|
parCols |
|
polys |
|
xyData |
|
Details
Internal functions check the validity of data objects used by PBSmapping.
The primary function is '.validateData'
; other dot validate
functions
are wrappers for the four main data structures:
'PolySet'
, 'PolyData'
, 'EventData'
, and 'LocationSet'
.
Value
The data object that is validated.
Author(s)
Nicholas M. Boers, Software Engineer, Jobber, Edmonton AB
Maintainer: Rowan Haigh, Program Head – Offshore Rockfish
Pacific Biological Station (PBS), Fisheries & Oceans Canada (DFO), Nanaimo BC
locus opus: Remote office, Vancouver BC
Last modified Rd: 2024-09-03
See Also
In package PBSmapping:
PolySet
,
PolyData
,
EventData
,
LocationSet