Learn R Programming

⚠️There's a newer version (1.1.36) 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 box
  • The production of images in the working directory with spectrograms to allow users organize data and verify acoustic analyzes

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,191

Version

1.1.21

License

GPL (>= 2)

Maintainer

Marcelo ArayaSalas

Last Published

February 4th, 2020

Functions in warbleR (1.1.21)

color_spectro

catalog2pdf

autodetec

Automatically detect vocalizations in sound files
color.spectro

Highlight spectrogram regions
checksels

Check selection data frames
catalog

Create catalog of vocal signals
checkwavs

Check .wav files
check_wavs

compare.methods

Assessing the performance of acoustic distance measurements
dfDTW

Acoustic dissimilarity using dynamic time warping on dominant frequency contours
compare_methods

ff_ts

cut_sels

Cut selections into individual sound files
dfts

Extract the dominant frequency values as a time series
consolidate

Consolidate (sound) files into a single directory
comp_matrix

auto_detec

check_sels

ff_DTW

ffDTW

Acoustic dissimilarity using dynamic time warping on fundamental frequency contours
fix_wavs

fixwavs

Fix .wav files to allow importing them into R
image_to_wave

Convert images into wave objects
imp.raven

deprecated functions and function names
ffts

Extract the fundamental frequency values as a time series
coor.graph

Coordinated singing graphs
coor.test

Randomization test for singing coordination
coor_graph

move.imgs

Move/copy image files between directories
full_spec

filter_sels

df_DTW

frange

Detect frequency range iteratively
filtersels

Subset selection data frames based on manually filtered image files
find_annotations

Obtain annotations from 'audioblast.org' data base
coor_test

df_ts

move_imgs

lspec

Create long spectrograms of whole sound files
frange.detec

Detect frequency range on wave objects
find_peaks

Find cross-correlation peaks
quer_xc

freq_range

is_extended_selection_table

Class 'extended_selection_table': selection table containing wave objects
is_selection_table

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

lspec2pdf combines lspec images in .jpeg format to a single pdf file.
freq_range_detec

full_spec2pdf

resample_est

Resample wave objects in a extended selection table
querxc

Access 'Xeno-Canto' recordings and metadata
new_function_names

Data frame detailing function name changes
mp32wav

Convert .mp3 files to .wav
rm_channels

Remove channels in wave files
specreator

Spectrograms of selected signals
sp.en.ts

Extract the spectral entropy across signals as a time series
xcorr

Time-frequency cross-correlation
lbh_selec_table

Data frame of selections (i.e. selection table).
multi_DTW

A wrapper on dtwDist for comparing multivariate contours
manualoc

Interactive view of spectrograms
lbh_selec_table2

Data frame of selections
read_wave

A wrapper for tuneR's readWave that read sound files listed within selection tables
fix_extended_selection_table

Fix extended selection tables
inflections

Count number of inflections in a frequency contour
spec_an

spectrograms

open_wd

Open working directory
mfcc_stats

Calculate descriptive statistics on Mel-frequency cepstral coefficients
warbleR-internals

warbleR Internal Functions
print.selection_table

print method for class selection_table
song_param

Calculates acoustic parameters at the song level
make.selection.table

rbind.extended_selection_table

rbind method for class extended_selection_table
rename_waves_est

Rename wave objects and associated metadata in extended selection tables
sel_tailor

ovlp_sels

Find overlapping selections
rbind.selection_table

rbind method for class selection_table
phylo_spectro

Add spectrograms onto phylogenetic trees
print.extended_selection_table

print method for class extended_selection_table
manual_loc

selection_table

Create 'selection_table' and 'extended_selection_table' objects
split_wavs

Splits sound files
rm_sil

Remove silence in wave files
snrspecs

Spectrograms with background noise margins
sig2noise

Measure signal-to-noise ratio
selec.table

Alternative name for selec.table
se_ts

spec_param

Plot a mosaic of spectrograms with varying display parameters
specan

Measure acoustic parameters in batches of sound files
sim.coor.sing

Simulated coordinated singing events.
snr_specs

warbleR

warbleR: A package to streamline bioacoustic analysis
try_na

Wrapper for "try" function
x_corr

wpd_features

Measure wavelet packet decomposition features (EXPERIMENTAL)
sort_colms

Sort columns in a more intuitive order
seltailor

Interactive view of spectrograms to tailor selections
track_harm

Track harmonic frequency contour
trackfreqs

Spectrograms with frequency measurements
xc_maps

xcmaps

Maps of 'Xeno-Canto' recordings by species
[.extended_selection_table

extract method for class extended_selection_table
warbleR_options

Setting warbleR options
sim_coor_sing

Alternative name for sim.coor.song
sim_songs

Simulate animal vocalizations
track_freqs

wav_dur

wavdur

Measure the duration of sound files
wav_info

Get wave file parameter information
[.selection_table

extract method for class selection_table