EventData {PBSmapping}R Documentation

EventData Objects

Description

PBS Mapping functions that expect EventData will accept properly formatted data frames in their place (see 'Details').

as.EventData attempts to coerce a data frame to an object with class EventData.

is.EventData returns TRUE if its argument is of class EventData.

Usage

as.EventData(x, projection = NULL, zone = NULL)
is.EventData(x, fullValidation = TRUE)

Arguments

x data frame to be coerced or tested.
projection optional projection attribute to add to EventData, possibly overwriting an existing attribute.
zone optional zone attribute to add to EventData, possibly overwriting an existing attribute.
fullValidation Boolean value; if TRUE, fully test x.

Details

We define EventData as a data frame with at least three fields named (EID, X, Y). Conceptually, an EventData object describes events that take place at specific points (X, Y) in two-dimensional space. Additional fields specify measurements associated with these events. For example, in a fishery context EventData could describe fishing events associated with trawl tows, based on the fields:

Like PolyData, EventData can have attributes projection and zone, which may be absent. Inserting the string "EventData" as the class attribute's first element alters the behaviour of some functions, including print (if PBSprint is TRUE) and summary.

Value

The as.EventData method returns an object with classes "EventData" and "data.frame", in that order.

See Also

LocationSet, PolyData, PolySet.


[Package PBSmapping version 2.09 Index]