calculateModuleData: Run Custom Calculations on Pamguard Module Data

Description Usage Arguments Value Author(s)

View source: R/calculateModuleData.R

Description

Run a list of custom calculations on a Pamguard binary file.

Usage

1
2
3
4
5
calculateModuleData(
  binData,
  binFuns = list(ClickDetector = list(standardClickCalcs)),
  settings = NULL
)

Arguments

binData

Pamguard binary data as read in by loadPamguardBinaryFile

binFuns

A named list of functions to run on each Pamguard module. Currently supported modules are 'ClickDetector' and 'WhistlesMoans', a sample input for binFuns would be list('ClickDetector'=list(clickFun1, clickFun2), 'WhistlesMoans'=list(wmFun1))

settings

a list of settings from a Pamguard XML file

Value

A data frame with one row for each channel of each detection. Each row will have the UID, channel number, and name of the detector. Clicks of different classifications are treated as different detectors for this purpose, with the classification label number appended to the detector name. The number of columns will depend on the results of the calculations from the supplied binFuns.

Author(s)

Taiki Sakai taiki.sakai@noaa.gov


PAMpal documentation built on Oct. 10, 2021, 1:06 a.m.