getDetectorData: Extract and Combine Detector Data

In PAMpal: Load and Process Passive Acoustic Data

Extract and Combine Detector Data

Description

Extracts just the detector data from all of x, and will combine all detections from each call type (currently whistle, click, and cepstrum) into a single data frame.

Usage

getDetectorData(x, measures = TRUE)

getClickData(x, measures = TRUE)

getWhistleData(x, measures = TRUE)

getCepstrumData(x, measures = TRUE)

getGPLData(x, measures = TRUE)

getFPODData(x, measures = TRUE)

nDetections(x, distinct = FALSE)

nClicks(x, distinct = FALSE)

nWhistles(x)

nCepstrum(x)

nGPL(x)

Arguments

x	data to extract detector data from, either an AcousticStudy, AcousticEvent or list of AcousticEvent object
measures	logical flag whether or not to append measures to detector dataframes
distinct	logical flag to only return number of distinct click detections

Details

The purpose of this function is to extract your data out of PAMpal's S4 classes and put them into an easier format to work with. The output will be a list of up to three data frames, one for each call type found in your data. Each different call type will have had different processing applied to it by processPgDetections. Additionally, each detector will have its associated event id, the name of the detector, and the species id attached to it (species will be NA if not set). All detections from each call type will be combined into a single large data frame

Value

A list of data frames containing all detection data from x, named by call type ('click', 'whistle', or 'cepstrum').

Author(s)

Taiki Sakai [e-mail]

Examples

data(exStudy)
dets <- getDetectorData(exStudy)
names(dets)
str(dets$click)
# works on single events as well
oneDets <- getDetectorData(exStudy[[1]])
str(oneDets$click)

PAMpal documentation built on Aug. 12, 2023, 1:06 a.m.