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

7,130

Version

1.1.25

License

GPL (>= 2)

Maintainer

Marcelo Araya-Salas

Last Published

January 27th, 2021

Functions in warbleR (1.1.25)

color.spectro

Highlight spectrogram regions
auto_detec

checkwavs

Check .wav files
checksels

Check selection data frames
autodetec

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

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

Create catalog of vocal signals
check_sels

check_wavs

compare_methods

color_spectro

comp_matrix

compare.methods

Assessing the performance of acoustic distance measurements
coor.graph

Coordinated singing graphs
filter_sels

coor.test

Randomization test for singing coordination
frange.detec

Detect frequency range on wave objects
filtersels

Subset selection data frames based on manually filtered image files
ffts

Extract the fundamental frequency values as a time series
ff_ts

coor_graph

coor_test

freq_range

dfts

Extract the dominant frequency values as a time series
ff_DTW

frange

Detect frequency range iteratively
ffDTW

Acoustic dissimilarity using dynamic time warping on fundamental frequency contours
fixwavs

Fix .wav files to allow importing them into R
imp.raven

deprecated functions and function names
inflections

Count number of inflections in a frequency contour
fix_extended_selection_table

Fix extended selection tables
multi_DTW

A wrapper on dtwDist for comparing multivariate contours
fix_wavs

new_function_names

Data frame detailing function name changes
move_imgs

mp32wav

Convert .mp3 files to .wav
cut_sels

Cut selections into individual sound files
querxc

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

rbind method for class extended_selection_table
envelope

Calculates the absolute amplitude envelope
quer_xc

read_sound_file

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

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

Consolidate (sound) files into a single directory
full_spec2pdf

df_DTW

is_selection_table

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

Simulate animal vocalizations
df_ts

freq_range_detec

rbind.selection_table

rbind method for class selection_table
lbh_selec_table

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

image_to_wave

Convert images into wave objects
warbleR-internals

warbleR Internal Functions
full_spec

x_corr

dfDTW

Acoustic dissimilarity using dynamic time warping on dominant frequency contours
find_peaks

Find cross-correlation peaks
lspec

Create long spectrograms of whole sound files
lbh_selec_table2

Data frame of selections
find_annotations

Obtain annotations from 'audioblast.org' data base
is_extended_selection_table

Class 'extended_selection_table': selection table containing wave objects
lspec2pdf

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

xc_maps

rename_waves_est

Rename wave objects and associated metadata in extended selection tables
make.selection.table

move.imgs

Move/copy image files between directories
mfcc_stats

Calculate descriptive statistics on Mel-frequency cepstral coefficients
resample_est

Resample wave objects in a extended selection table
sort_colms

Sort columns in a more intuitive order
sp.en.ts

Extract the spectral entropy across signals as a time series
track_harm

Track harmonic frequency contour
wav_info

Get wave file parameter information
track_freqs

wav_dur

rm_channels

Remove channels in wave files
ovlp_sels

Find overlapping selections
manualoc

Interactive view of spectrograms
phylo_spectro

Add spectrograms onto phylogenetic trees
selection_table

Create 'selection_table' and 'extended_selection_table' objects
snrspecs

Spectrograms with background noise margins
specan

Measure acoustic parameters in batches of sound files
selec.table

Alternative name for lbh_selec_table
song_param

Calculates acoustic parameters at the song level
print.selection_table

print method for class selection_table
sel_tailor

se_ts

print.extended_selection_table

print method for class extended_selection_table
open_wd

Open working directory
specreator

Spectrograms of selected signals
optimize_autodetec

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

Alternative name for sim.coor.song
seltailor

Interactive view of spectrograms to tailor selections
sim.coor.sing

Simulated coordinated singing events.
sig2noise

Measure signal-to-noise ratio
split_wavs

Splits sound files
spectrograms

rm_sil

Remove silence in wave files
[.selection_table

extract method for class selection_table
[.extended_selection_table

extract method for class extended_selection_table
spec_an

warbleR

warbleR: A package to streamline bioacoustic analysis
spec_param

Plot a mosaic of spectrograms with varying display parameters
wavdur

Measure the duration of sound files
try_na

Wrapper for "try" function
trackfreqs

Spectrograms with frequency measurements
warbleR_options

Setting warbleR options
xcorr

Time-frequency cross-correlation
xcmaps

Maps of 'Xeno-Canto' recordings by species
wpd_features

Measure wavelet packet decomposition features (EXPERIMENTAL)