beatComplexity: Beat spectrum complexity

View source: R/beatComplexity.R

beatComplexityR Documentation

Beat spectrum complexity

Description

This function computes a beatSpectrum and calculates some basic measurements of its complexity. The complexity value is calculated as the maximum identified repeating period (in seconds) divided by the number of peaks.

Usage

beatComplexity(wave, plot = FALSE)

Arguments

wave

A Wave object

plot

If TRUE a spectrogram overlaid with the peaks is plotted.

Value

A list of the complexity, a vector of the peak periods, and the number of peaks.

Examples

## Not run: 
  beatComplexity(sheep)
  beatComplexity(sheep, plot=TRUE)

## End(Not run)

sonicscrewdriver documentation built on May 29, 2024, 3:39 a.m.