PAMpalSettings-class: 'PAMpalSettings' Class

PAMpalSettings-classR Documentation

PAMpalSettings Class

Description

An S4 class that stores settings related to all processing and analysis steps done in PAMpal. A PAMpalSettings object will be the main input to any major function in the PAMpal package.

Slots

db

the full path to a PamGuard database file

binaries

a list with items "folder" containing the directory of the PamGuard binary files, and "list" containing the full path to each individual binary file.

functions

a named list of functions to apply to data read in by PAMpal. Should be named by the PamGuard module the function should be applied to. Currently supports "ClickDetector", "WhistlesMoans", and "Cepstrum".

calibration

a named list of calibration functions to apply while applying functions from the "functions" slot. Should named by the PamGuard module, same as the "functions"

settings

a named list of settings, usually imported from Pamguard's "Export XML Configuration"

Author(s)

Taiki Sakai taiki.sakai@noaa.gov


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