checkStudy: Check an AcousticStudy Object for Issues

In PAMpal: Load and Process Passive Acoustic Data

Check an AcousticStudy Object for Issues

Description

Checks for any possible issues in an AcousticStudy object, issuing warnings and saving the messages

Usage

checkStudy(x, maxLength = Inf, maxSep = 60 * 60 * 2)

Arguments

x	an AcousticStudy object
maxLength	events with length greater than this value in seconds will trigger a warning
maxSep	events containing consecutive detections greater than maxSep seconds apart will trigger a warning. This is used to check for situations where detections were possibly added to the incorrect event.

Details

This function is called at the end of processPgDetections with default parameters, but can also be called later to investigate issues specific to each user's data. For example, if you are expecting to process data where all recordings were duty cycled to record 2 out of every 10 minutes, then setting maxLength = 60*2 will alert you to any events that are longer than the 2 minute duty cycle. For continuously recorded data, the maxSep argument can be used to identify situations where there are large gaps between detections in a single event, since this could mean that detections were accidentally added to the incorrect event number during processing.

Value

returns a list of warning messages

Author(s)

Taiki Sakai [e-mail]

Examples

data(exStudy)

# checks if any peak frequencies are 0, so we'll force this
exStudy[[1]][[1]]$peak <- 0
checkStudy(exStudy)
checkStudy(exStudy, maxLength = 1, maxSep = 1)

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