Learn R Programming

⚠️There's a newer version (1.1.32) of this package.Take me there.

warbleR

warbleR is intended to facilitate the analysis of the structure of animal acoustic signals in R. Users can collect open-access avian recordings or enter their own data into a workflow that facilitates spectrographic visualization and measurement of acoustic parameters. warbleR makes use of the fundamental sound analysis tools of the seewave package, and offers new tools for acoustic structure analysis. These tools are available for batch analysis of acoustic signals.

The main features of the package are:

  • The use of loops to apply tasks through acoustic signals referenced in a selection table
  • The production of images in the working directory with spectrograms to allow users organize data and verify acoustic analyses

The package offers functions to:

  • Explore and download Xeno ‐ Canto recordings
  • Explore, organize and manipulate multiple sound files
  • Detect signals automatically (in frequency and time)
  • Create spectrograms of complete recordings or individual signals
  • Run different measures of acoustic signal structure
  • Evaluate the performance of measurement methods
  • Catalog signals
  • Characterize different structural levels in acoustic signals
  • Statistical analysis of duet coordination
  • Consolidate databases and annotation tables

Most of the functions allow the parallelization of tasks, which distributes the tasks among several processors to improve computational efficiency. Tools to evaluate the performance of the analysis at each step are also available. In addition, warbleR satisfies the need for rigorous open source bioacoustic analysis, which facilitates opportunities for use in research and innovation of additional custom analyzes.

Install/load the package from CRAN as follows:

install.packages("warbleR")

#load package
library(warbleR)

To install the latest developmental version from github you will need the R package devtools:

devtools::install_github("maRce10/warbleR")

#load package
library(warbleR)

For details and example usage, visit the warbleR package website.

A full description of the package can be found in this journal article.

Please cite warbleR as follows:

Araya-Salas, M. and Smith-Vidaurre, G. (2017), warbleR: an r package to streamline analysis of animal acoustic signals. Methods Ecol Evol. 8, 184-191. PDF

NOTE: please also cite the tuneR and seewave packages if you use any spectrogram-creating or acoustic-measuring functions

Copy Link

Version

Install

install.packages('warbleR')

Monthly Downloads

1,188

Version

1.1.26

License

GPL (>= 2)

Last Published

March 9th, 2021

Functions in warbleR (1.1.26)

check_sels

Check selection data frames
auto_detec

auto_detec automatically detects the start and end of vocalizations in sound files based on amplitude, duration, and frequency range attributes.
checksels

color.spectro

catalog2pdf

Combine catalog images into pdfs catalog2pdf combines catalog jpeg images into pdfs
catalog

Create catalog of vocal signals
color_spectro

Highlight spectrogram regions
checkwavs

autodetec

check_wavs

Check .wav files
consolidate

Consolidate (sound) files into a single directory
compare_methods

Assessing the performance of acoustic distance measurements
cut_sels

Cut selections into individual sound files
cross_correlation

Time-frequency cross-correlation
envelope

Calculates the absolute amplitude envelope
duration_wavs

Measure the duration of sound files
fix_wavs

Fix .wav files to allow importing them into R
comp_matrix

dfDTW

fixwavs

df_DTW

find_peaks

Find cross-correlation peaks
freq_range_detec

Detect frequency range on wave objects
full_spectrograms

Create long spectrograms of whole sound files
full_spectrogram2pdf

full_spectrogram2pdf combines full_spectrograms images in .jpeg format to a single pdf file.
freq_ts

Extract frequency contours as time series
inflections

Count number of inflections in a frequency contour
coor.graph

image_to_wave

Convert images into wave objects
ffDTW

deprecated functions and function names
lspec2pdf

lspec

filtersels

coor.test

compare.methods

map_xc

Maps of 'Xeno-Canto' recordings by species
is_extended_selection_table

Class 'extended_selection_table': selection table containing wave objects
filter_sels

Subset selection data frames based on manually filtered image files
is_selection_table

Class 'selection_table': double-checked frequency/time coordinates of selections
info_wavs

Get wave file parameter information
mp32wav

Convert .mp3 files to .wav
optimize_auto_detec

Optimize the detection of signals based on a-priori detections
open_wd

Open working directory
move_imgs

Move/copy image files between directories
warbleR-internals

warbleR Internal Functions
rename_est_waves

Rename wave objects and associated metadata in extended selection tables
print.extended_selection_table

print method for class extended_selection_table
rename_waves_est

remove_silence

Remove silence in wave files
multi_DTW

A wrapper on dtwDist for comparing multivariate contours
lbh_selec_table

Example data frame of selections (i.e. selection table).
lbh_selec_table2

Example data frame of selections (i.e. selection table).
querxc

freq_DTW

Acoustic dissimilarity using dynamic time warping on dominant frequency contours
fix_extended_selection_table

Fix extended selection tables
read_wave

A wrapper for tuneR's readWave that read sound files listed within selection tables
selec.table

Alternative name for lbh_selec_table
freq_range

Detect frequency range iteratively
rbind.extended_selection_table

rbind method for class extended_selection_table
rbind.selection_table

rbind method for class selection_table
sim_songs

Simulate animal vocalizations
remove_channels

Remove channels in wave files
tailor_sels

Interactive view of spectrograms to tailor selections
snr_specs

new_function_names

Data frame detailing function name changes
find_annotations

Obtain annotations from audioblast.org data base
[.selection_table

extract method for class selection_table
frange.detec

frange

make.selection.table

phylo_spectro

Add spectrograms onto phylogenetic trees
mfcc_stats

Calculate descriptive statistics on Mel-frequency cepstral coefficients
move.imgs

specreator

specan

sort_colms

Sort columns in a more intuitive order
print.selection_table

print method for class selection_table
trackfreqs

track_harmonic

Track harmonic frequency contour
track_freq_contour

Spectrograms with frequency measurements
test_coordination

Randomization test for singing coordination
try_na

Wrapper for "try" function
tweak_spectro

Plot a mosaic of spectrograms with varying display parameters
spec_param

plot_coordination

Coordinated singing graphs
selection_table

Create 'selection_table' and 'extended_selection_table' objects
sim_coor_sing

Simulated coordinated singing events.
xcmaps

xcorr

seltailor

sig2noise

Measure signal-to-noise ratio
warbleR

warbleR: A package to streamline bioacoustic analysis
warbleR_options

Setting warbleR options
overlapping_sels

Find overlapping selections
wavdur

read_sound_file

A extended version of read_wave that reads several sound file formats and files from selection tables
ovlp_sels

rm_sil

spectro_analysis

Measure acoustic parameters in batches of sound files
query_xc

Access 'Xeno-Canto' recordings and metadata
[.extended_selection_table

extract method for class extended_selection_table
wpd_features

Measure wavelet packet decomposition features (EXPERIMENTAL)
song_param

resample_est_waves

Resample wave objects in a extended selection table
rm_channels

song_analysis

Calculates acoustic parameters at the song level
spectrograms

Spectrograms of selected signals
snr_spectrograms

Spectrograms with background noise margins
snrspecs

split_wavs

Splits sound files