summariseDiveDepth: Summarise Dive Depth

View source: R/summariseDiveDepth.R

summariseDiveDepthR Documentation

Summarise Dive Depth

Description

Summarise results of dive depth estimation using calculateEchoDepth and related functions

Usage

summariseDiveDepth(x, hpDepthError = 1, locType = "PGTargetMotion")

Arguments

x

an AcousticStudy that has been processed with calculateEchoDepth

hpDepthError

hydrophone depth error to use for error estimation

locType

name of localization, note that this function is not computing any localization, only using previously calculated

Value

a dataframe with columns summarising the estimated dive depth for each event in x

Author(s)

Taiki Sakai taiki.sakai@noaa.gov

Examples

# example not run because \link{calculateEchoDepth} must be run first,
# and it requires a large amount of data not stored in the package
## Not run: 
study <- calculateEchoDepth(study, wav='path/to/wavFiles')
summariseDiveDepth(study)

## End(Not run)


PAMpal documentation built on Sept. 11, 2024, 6:31 p.m.