seewave (version 2.2.3)

AR: Acoustic Richness index

Description

This function computes the Acoustic Richness index based on M and Ht indices

Usage

AR(..., datatype = "objects", envt = "hil",
msmooth = NULL, ksmooth = NULL, ssmooth = NULL,
pattern = "[wav]$|[WAV]$|[mp3]$")

Value

A data.frame with three columns (M, Ht, AR) and n columns, with n the number of objects (respectively files) used as input.

Arguments

...

Wave, WaveMC, audioSample objects if datatype="objects", or a path as a character string to a directory including .wav and/or .mp3 files if datatype="files".

datatype

A character string to specify if inputs are either R objects (datatype="objects", default) or files (datatype="files").

envt

the type of envelope to be returned: either "abs" for absolute amplitude envelope or "hil" for Hilbert (default) amplitude envelope. See env.

msmooth

mean smooth. See env.

ksmooth

kernel smooth via kernel. See env.

ssmooth

sum smooth. See env.

pattern

an optional regular expression. Only file names which match the regular expression will be returned when datatype="files". By default .wav or .mp3 files. See dir.

Author

Jerome Sueur and Marion Depraetere

Details

AR is ranked index based on the rank of the M and Ht indices obtained with the functions M and th respectively following: $$AR = \frac{rank(M) \times rank(H_{t})}{n^2}$$ with $$0 \leq AR \leq 1$$

References

Depraetere M, Pavoine S, Jiguet F, Gasc A, Duvail S, Sueur J (2012) Monitoring animal diversity using acoustic indices: implementation in a temperate woodland. Ecological Indicators, 13, 46-54.

See Also

M, th, env

Examples

## input as R objects
data(orni)
data(tico)
AR(orni, tico)
## give names to objects if you wish to have them as row names of the returned data.frame
AR(orni=orni, tico=tico)
## input as files stored in the working directory
## file names will be used as row names of the returned data.frame
if (FALSE) {
require(tuneR)
AR(getwd(), datatype="files")
}