show-methods: Methods for the 'show' and 'summary' Functions

In jonkatz2/monitoR: Acoustic Template Detection in R

Methods for the show and summary Functions

Description

These methods are used for viewing template lists and other objects. For all types of objects documented here, show and summary will produce identical results.

Methods

signature(object = "binTemplateList")

Displays a summary of binTemplateList objects.

signature(object = "corTemplateList")

Displays a summary of corTemplateList objects.

signature(object = "TemplateList")

Displays a summary of TemplateList objects.

signature(object = "detectionList")

Displays a summary of detectionList objects.

signature(object = "templateScores")

Displays a summary of templateScores objects.

Author(s)

Sasha D. Hafner

See Also

makeCorTemplate, makeBinTemplate

Examples

# Load data
data(btnw)
data(oven)

# Write Wave objects to file (temporary directory used here)
btnw.fp <- file.path(tempdir(), "btnw.wav")
oven.fp <- file.path(tempdir(), "oven.wav")
writeWave(btnw, btnw.fp)
writeWave(oven, oven.fp)

# Correlation example
# Create two correlation templates
wct <- makeCorTemplate(btnw.fp, t.lim = c(1.5, 2.1), frq.lim = c(4.2, 5.6), name = "w")
oct <- makeCorTemplate(oven.fp, t.lim = c(1, 4), frq.lim = c(1, 11), dens = 0.1, name = "o")

# Combine them
ctemps <- combineCorTemplates(wct, oct)

# Then for a quick summary:
ctemps

# Clean up (only because these files were created in these examples)
file.remove(btnw.fp)
file.remove(oven.fp)

jonkatz2/monitoR documentation built on June 12, 2025, 7:33 p.m.