Learn R Programming

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

warbleR

A tool to streamline the analysis of animal acoustic signal structure. The package offers functions for downloading avian vocalizations from the open-access online repository Xeno-Canto, displaying the geographic extent of the recordings, manipulating sound files, detecting acoustic signals, assessing performance of methods that measure acoustic similarity, conducting cross-correlations, dynamic time warping, measuring acoustic parameters and analysing interactive vocal signals, among others. Functions working iteratively allow parallelization to improve computational efficiency.The code in warbleR can be executed by less experienced R users, but has also been thoroughly commented, which will facilitate further customization by advanced users.

Install/load the package from CRAN as follows:


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

#load package
library(Rraven)

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)

The package vignettes provide detailed examples for most warbleR functions. You can pull up the vignettes as follows:


vignette("warbleR_workflow_phase1")

vignette("warbleR_workflow_phase2")

vignette("warbleR_workflow_phase3")

A full description of the package can be founf 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.13

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Marcelo ArayaSalas

Last Published

May 18th, 2018

Functions in warbleR (1.1.13)

dfDTW

Acoustic dissimilarity using dynamic time warping on dominant frequency contours
dfts

Extract the dominant frequency values as a time series
is_selection_table

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

Fix extended selection tables
lspec

Create long spectrograms of whole sound files
ffts

Extract the fundamental frequency values as a time series
is_extended_selection_table

Class 'extended_selection_table': selection table containing wave objects
snrspecs

Spectrograms with background noise margins
lspec2pdf

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

Subset selection data frames based on manually filtered image files
ffDTW

Acoustic dissimilarity using dynamic time warping on fundamental frequency contours
filter_sels

mp32wav

Convert .mp3 files to .wav
ovlp_sels

Find overlapping selections
fixwavs

Fix .wav files to allow importing them into R
full_spec

fix_wavs

full_spec2pdf

new_function_names

Data frame detailing function name changes
move_imgs

freq_range

song_param

Measure acoustic parameters at the song level
try_na

Wrapper for "try" function
trackfreqs

Spectrograms with frequency measurements
print.extended_selection_table

print method for class extended_selection_table
sig2noise

Measure signal-to-noise ratio
open_wd

Open working directory
[.extended_selection_table

extract method for class extended_selection_table
[.selection_table

extract method for class selection_table
seltailor

Interactive view of spectrograms to tailor selections
make.selection.table

rbind.selection_table

rbind method for class selection_table
freq_range_detec

frange.detec

Detect frequency range on wave objects
frange

Detect frequency range iteratively
manualoc

Interactive view of spectrograms
selec_table

Alternative name for selec.table
manual_loc

ff_DTW

read_wave

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

Access 'Xeno-Canto' recordings and metadata
selection_table

Create 'selection_table' and 'extended_selection_table' objects
move.imgs

Move/copy image files between directories
rm_sil

Remove silence in wave files
specreator

Spectrograms of selected signals
ff_ts

se_ts

sim.coor.sing

Simulated coordinated singing events.
rbind.extended_selection_table

rbind method for class extended_selection_table
sim_coor_sing

Alternative name for sim.coor.song
sel_tailor

spectrograms

wav_dur

wavdur

Measure the duration of sound files
selec.table

Data frame of selections (i.e. selection table).
sp.en.ts

Extract the spectral entropy across signals as a time series
x_corr

spec_an

xc_maps

inflections

Count number of inflections in a frequency contour
print.selection_table

print method for class selection_table
warbleR-internals

warbleR Internal Functions
quer_xc

sim_songs

Simulate animal vocalizations
track_freqs

spec_param

Plot a mosaic of spectrograms with varying display parameters
snr_specs

track_harm

Track harmonic frequency contour
xcorr.graph

Pairwise plots of spectrogram cross-correlation scores
xcorr_graph

warbleR

warbleR: A package to streamline bioacoustic analysis
warbleR_options

Setting warbleR options
specan

Measure acoustic parameters in batches of sound files
xcorr

Spectrogram cross-correlation
xcmaps

Maps of 'Xeno-Canto' recordings by species
checkwavs

Check .wav files
catalog

Create catalog of vocal signals
compare.methods

Assessing the performance of acoustic distance measurements
color_spectro

autodetec

Automatically detect vocalizations in sound files
color.spectro

Highlight spectrogram regions
check_wavs

coor.test

Randomization test for singing coordination
checksels

Check selection data frames
auto_detec

coor_graph

coor_test

df_ts

coor.graph

Coordinated singing graphs
df_DTW

cut_sels

Cut selections into individual sound files
catalog2pdf

compare_methods

consolidate

Consolidate (sound) files into a single folder