ARUtools (version 0.7.2)

acoustic_indices: Get acoustic complexity values

Description

Wrapper for 'soundecology' package to calculate acoustic complexity, the bioacoustic index, and acoustic diversity. See Value for details about these indices.

Usage

acoustic_indices(
  path,
  min_freq = NA,
  max_freq = NA,
  units = "samples",
  quiet = FALSE
)

Value

Returns a data frame with acoustic indices. Those prefaced with

• complx_ are from soundecology::acoustic_complexity()

• bio_ are from soundecology::bioacoustic_index()

• div_ are from soundecology::acoustic_diversity()

Arguments

path

Character. Path to wave file.

min_freq

Numeric. Minimum frequency for acoustic complexity (see soundecology::acoustic_complexity())

max_freq

Numeric. Maximum frequency for acoustic complexity (see soundecology::acoustic_complexity())

units

Character. Wave file units for reading the file. Defaults to "samples" (see tuneR::readWave()).

quiet

Logical. Whether to suppress progress messages and other non-essential updates.

Examples

w <- tuneR::sine(440, duration = 300000) # > 5s
tuneR::writeWave(w, "test_wave.wav")
acoustic_indices("test_wave.wav")
acoustic_indices("test_wave.wav", quiet = TRUE)
unlink("test_wave.wav")