Learn R Programming

PAMpal

Welcome! The tutorial has moved to here.

Please reach out if you have any issues taiki.sakai@noaa.gov.

Installation Guide

PAMpal is available on CRAN and can be installed with

install.packages('PAMpal')

A more recent development version may be available on GitHub, and can be installed with

devtools::install_github('TaikiSan21/PAMpal')

Copy Link

Version

Install

install.packages('PAMpal')

Monthly Downloads

408

Version

1.5.2

License

GNU General Public License

Maintainer

Taiki Sakai

Last Published

February 26th, 2026

Functions in PAMpal (1.5.2)

filterEchoDepths

Filter Candidate Echo Depths
export_banter

Export Data for a BANTER Model
calculateModuleData

Run Custom Calculations on Pamguard Module Data
checkStudy

Check an AcousticStudy Object for Issues
filter.AcousticStudy

Filter an AcousticStudy or AcousticEvent Object
calculateICI

Calculate Inter-Click Interval
calculateEchoDepth

Calculate Depth from Echoes
getBinaryData

Get Raw Binary Data for Detections
getClipData

Get Wav Clips of Data
exStudy

Example AcousticStudy Object
matchTimeData

Match time-based data to PAMpal objects
markAnnotated

Mark Detections as Annotated
is.PAMpalSettings

Check if an Object is a PAMpalSettings
matchEnvData,AcousticEvent-method

Match Environmental Data to an AcousticStudy Object
is.AcousticStudy

Check if an Object is an AcousticStudy
getWarnings

Get Warning Messages
loadPamguardXML

Load Pamguard XML Settings
getDetectorData

Extract and Combine Detector Data
is.AcousticEvent

Check if an Object is an AcousticEvent
plotDataExplorer

Explore Data in an Interactive Shiny Plot
plotGram

Plot Spectrogram or Cepstrogram
removeDatabase

Remove a Database from a PAMpalSettings Object
removeBinaries

Remove Binaries from a PAMpalSettings Object
removeSettings

Remove Settings from a PAMpalSettings Object
roccaWhistleCalcs

Calculate a Set of Measurements for Whistles
removeCalibration

Remove a Calibration Function from a PAMpalSettings Object
plotWaveform

Plot Graphical Representations of Waveforms
removeFunction

Remove a Function from a PAMpalSettings Object
runDepthReview

Run Echo Depth Review App
removeNote

removeNote
processPgDetections

Load and Process Detections from Pamguard
testGPL

A fake GPL detection
setSpecies

Set the Species Classification of Events
standardCepstrumCalcs

Calculate a Set of Measurements from a Cepstrum Contour
sampleDetector

Subsample Detectors in AcousticStudy
runIciReview

Run ICI Review App
summariseDiveDepth

Summarise Dive Depth
standardClickCalcs

Calculate a Set of Measurements for Clicks
testCeps

A fake cepstrum contour
testClick

A two-channel recording of a delphinid click
updatePamObject

Update PAMpal S4 Object
writeEventClips

Create Wav Clips of Data
writeWignerData

Write Wigner Transform Data of Click Detections to Disk
updateFiles

Update Location of Files in an AcousticStudy
testWhistle

A fake whistle contour
AcousticEvent-class

AcousticEvent Class
PAMpalSettings-class

PAMpalSettings Class
PAMpalSettings

Constructor for PAMpalSettings Object
addCalibration

Add a Calibration File to a PAMpalSettings Object
addBinaries

Add Binaries to a PAMpalSettings Object
addAnnotation

Add Annotation Data to an AcousticStudy Object
addDatabase

Add a Database to a PAMpalSettings Object
addFPOD

Add FPOD Detector to an AcousticStudy
AcousticStudy-class

AcousticStudy Class
PAMpal.accessors

AcousticEvent and AcousticStudy accessors
bindStudies

Combine AcousticStudy Objects
addFunction

Add a Function to a PAMpalSettings Object
addRecordings

Add Recordings to an AcousticStudy Object
calculateAverageSpectra

Calculate Average Spectra of Clicks
addSettings

Add Settingss to a PAMpalSettings Object
addGps

Add GPS Locations to an AcousticStudy
addHydrophoneDepth

Add Hydrophone Depth Data to an AcousticStudy
addWaveHeight

Add Wave Height Data to an AcousticStudy
addNote

addNote
addMeasures

Add Measures