TDR-class {diveMove}R Documentation

Classes "TDR" and "TDRspeed" for representing TDR information

Description

These classes store information gathered by time-depth recorders.

Usage

## S4 method for signature 'TDR, numeric, numeric':
extractDive(obj, diveNo, id)

Arguments

obj "TDR" object.
diveNo numeric vector or scalar with dive numbers to extract.
id numeric vector of dive numbers from where diveNo should be chosen.

Details

Since the data to store in objects of these clases usually come from a file, the easiest way to construct such objects is with the function readTDR to retrieve all the necessary information. The methods listed above can thus be used to access all slots.

Objects from the Class

Objects can be created by calls of the form new("TDR", ...) and new("TDRspeed", ...).

TDR objects contain concurrent time and depth readings, as well as a string indicating the file the data originates from, and a number indicating the sampling interval for these data. TDRspeed extends TDR objects containing additional concurrent speed readings.

Slots

In class TDR:

file:
Object of class "character", string indicating the file where the data comes from.
dtime:
Object of class "numeric", sampling interval in seconds.
time:
Object of class "POSIXct", time stamp for every reading.
depth:
Object of class "numeric", depth (m) readings.

Class TDRspeed adds:

speed:
Object of class "numeric" speed (m/s) readings.

Methods

as.data.frame
signature(x="TDR"): Coerce object to data.frame.
as.data.frame
signature(x="TDRspeed"): Coerce object to data.frame.
coerce
signature(from="TDR", to="data.frame"): Coerce object to data.frame.
coerce
signature(from="TDRspeed", to="data.frame"): Coerce object to data.frame.
getDepth
signature(x = "TDR"): depth slot accessor.
getDtime
signature(x = "TDR"): sampling interval accessor.
extractDive
signature(obj = "TDR", diveNo = "numeric", id = "numeric"): extract particular dives.
getFileName
signature(x="TDR"): source file name accessor.
plot
signature(x = "TDR", y = "missing"): interactive graphical display of the data, with zooming and panning capabilities.
plot
signature(x = "TDRspeed", y = "missing"): As the TDR method, but also plots the speed slot.
show
signature(object = "TDR"): print an informative summary of the data.
getTime
signature(x = "TDR"): time slot accessor.
getSpeed
signature(x = "TDRspeed"): speed accessor for TDRspeed objects.

Author(s)

Sebastian P. Luque spluque@gmail.com

See Also

readTDR, TDRcalibrate-class.


[Package diveMove version 0.6-2 Index]