diveMove (version 1.6.4)

calibrateSpeed: Calibrate and build a "TDRcalibrate" object

Description

These functions create a TDRcalibrate object which is necessary to obtain dive summary statistics.

Usage

calibrateSpeed(
  x,
  tau = 0.1,
  contour.level = 0.1,
  z = 0,
  bad = c(0, 0),
  main = slot(getTDR(x), "file"),
  coefs,
  plot = TRUE,
  postscript = FALSE,
  ...
)

Value

An object of class TDRcalibrate.

Arguments

x

An object of class TDR for calibrateDepth or an object of class TDRcalibrate for calibrateSpeed.

tau

numeric scalar: quantile on which to regress speed on rate of depth change; passed to rq.

contour.level

numeric scalar: the mesh obtained from the bivariate kernel density estimation corresponding to this contour will be used for the quantile regression to define the calibration line.

z

numeric scalar: only changes in depth larger than this value will be used for calibration.

bad

numeric vector of length 2 indicating that only rates of depth change and speed greater than the given value should be used for calibration, respectively.

main, ...

Arguments passed to rqPlot.

coefs

numeric: known speed calibration coefficients from quantile regression as a vector of length 2 (intercept, slope). If provided, these coefficients are used for calibrating speed, ignoring all other arguments, except x.

plot

logical: whether to plot the results.

postscript

logical: whether to produce postscript file output.

Author

Sebastian P. Luque

Details

This calibrates speed readings following the procedure outlined in Blackwell et al. (1999).

References

Blackwell S, Haverl C, Le Boeuf B, Costa D (1999). A method for calibrating swim-speed recorders. Marine Mammal Science 15(3):894-905.

See Also

TDRcalibrate

Examples

## Too long for checks
## Continuing the Example from '?calibrateDepth':
utils::example("calibrateDepth", package="diveMove",
               ask=FALSE, echo=FALSE, run.donttest=TRUE)
dcalib		# the 'TDRcalibrate' that was created

## Calibrate speed using only changes in depth > 2 m
vcalib <- calibrateSpeed(dcalib, z=2)
vcalib