Learn R Programming

PAMpal (version 1.4.4)

summariseDiveDepth: Summarise Dive Depth

Description

Summarise results of dive depth estimation using calculateEchoDepth and related functions

Usage

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

Value

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

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

Author

Taiki Sakai taiki.sakai@noaa.gov

Examples

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

Run the code above in your browser using DataLab