Learn R Programming

⚠️There's a newer version (1.1.34) 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 folder with spectrograms that allow to 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:


# From CRAN would be
#install.packages("warbleR")

#load package
library(warbleR)

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

# From CRAN would be
#install.packages("warbleR")

# From github
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

7,146

Version

1.1.16

License

GPL (>= 2)

Maintainer

Marcelo ArayaSalas

Last Published

September 3rd, 2019

Functions in warbleR (1.1.16)

color.spectro

Highlight spectrogram regions
check_sels

checksels

Check selection data frames
checkwavs

Check .wav files
color_spectro

catalog

Create catalog of vocal signals
check_wavs

auto_detec

autodetec

Automatically detect vocalizations in sound files
dfDTW

Acoustic dissimilarity using dynamic time warping on dominant frequency contours
coor.test

Randomization test for singing coordination
catalog2pdf

compare.methods

Assessing the performance of acoustic distance measurements
is_extended_selection_table

Class 'extended_selection_table': selection table containing wave objects
dfts

Extract the dominant frequency values as a time series
lbh_selec_table

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

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

warbleR Internal Functions
df_ts

compare_methods

df_DTW

ffDTW

Acoustic dissimilarity using dynamic time warping on fundamental frequency contours
ff_DTW

coor_graph

spec_an

multi_DTW

A wrapper on dtwDist for comparing multivariate contours
rm_sil

Remove silence in wave files
move.imgs

Move/copy image files between directories
mp32wav

Convert .mp3 files to .wav
sp.en.ts

Extract the spectral entropy across signals as a time series
move_imgs

new_function_names

Data frame detailing function name changes
open_wd

Open working directory
xcmaps

Maps of 'Xeno-Canto' recordings by species
xcorr

Spectrogram cross-correlation
inflections

Count number of inflections in a frequency contour
selec.table

Alternative name for selec.table
full_spec2pdf

manual_loc

sel_tailor

make.selection.table

fix_wavs

fix_extended_selection_table

Fix extended selection tables
fixwavs

Fix .wav files to allow importing them into R
coor_test

coor.graph

Coordinated singing graphs
ffts

Extract the fundamental frequency values as a time series
consolidate

Consolidate (sound) files into a single directory
se_ts

ff_ts

freq_range_detec

snr_specs

cut_sels

Cut selections into individual sound files
sim_coor_sing

Alternative name for sim.coor.song
filter_sels

full_spec

mfcc_stats

Calculate descriptive statistics on Mel-frequency cepstral coefficients
print.selection_table

print method for class selection_table
manualoc

Interactive view of spectrograms
print.extended_selection_table

print method for class extended_selection_table
filtersels

Subset selection data frames based on manually filtered image files
phylo_spectro

Add spectrograms onto phylogenetic trees
frange.detec

Detect frequency range on wave objects
freq_range

ovlp_sels

Find overlapping selections
snrspecs

Spectrograms with background noise margins
[.selection_table

extract method for class selection_table
track_freqs

rbind.selection_table

rbind method for class selection_table
sim_songs

Simulate animal vocalizations
selection_table

Create 'selection_table' and 'extended_selection_table' objects
read_wave

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

Interactive view of spectrograms to tailor selections
trackfreqs

Spectrograms with frequency measurements
track_harm

Track harmonic frequency contour
querxc

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

rbind method for class extended_selection_table
frange

Detect frequency range iteratively
lspec

Create long spectrograms of whole sound files
spec_param

Plot a mosaic of spectrograms with varying display parameters
lspec2pdf

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

Resample wave objects in a extended selection table
quer_xc

quer_ml

deprecated functions and function names
song_param

Calculates acoustic parameters at the song level
rm_channels

Remove channels in wave files
split_wavs

Splits sound files
sig2noise

Measure signal-to-noise ratio
sim.coor.sing

Simulated coordinated singing events.
warbleR_options

Setting warbleR options
specan

Measure acoustic parameters in batches of sound files
wav_dur

[.extended_selection_table

extract method for class extended_selection_table
sort_colms

Sort columns in a more intuitive order
x_corr

warbleR

warbleR: A package to streamline bioacoustic analysis
try_na

Wrapper for "try" function
xcorr.graph

Pairwise plots of spectrogram cross-correlation scores
xc_maps

xcorr_graph

specreator

Spectrograms of selected signals
wavdur

Measure the duration of sound files
wav_info

Get wave file parameter information
spectrograms