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 |
data.frame|matrix – data object for use in PBSmapping functions
|
className |
character – class name of data , usually 'data.frame'
|
requiredCols |
character – vector of required field names in data
|
requiredAttr |
character – names of attributes to check
|
noFactorCols |
character – vector of field names that cannot be factors
|
noNACols |
character – vector of field names that cannot comtain NA values
|
keyCols |
character – vector of field names that must contain unique values
|
numericCols |
character – vector of field names that must be numeric
|
EventData |
data.frame – data frame with at least three fields named
('EID' , 'X' , 'Y' )
|
LocationSet |
data.frame – data frame with three or four columns
('EID' , 'PID' , 'SID' , 'Bdry' ), where 'SID' may be missing
|
PolyData |
data.frame – data frame with a first column named 'PID' and
(optionally) a second column named 'SID'
|
polyProps |
data.frame – support PolyData object,
usually containing fields that facilitate plotting,
either derived from a PolySet summary or given as an explicit PolyData object
|
parCols |
character – vector of field names that cannot be factors
|
polys |
data.frame – a collection of polygonal contours (PolySet )
based on four or five numerical fields:
'PID' the primary identification number for a contour
'SID' (optional) the secondary identification number for a contour
'POS' the position number associated with a vertex
'X' the horizontal coordinate at a vertex
'Y' the vertical coordinate at a vertex
|
xyData |
data.frame – a collection of events that contain fields 'X' and 'Y'
|
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
[Package
PBSmapping version 2.74.1
Index]