A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

warbleR

Is intended to facilitate the analysis of the structure of animal acoustic signals in R.
https://github.com/marce10/warbler

Category: Biosphere
Sub Category: Bioacoustics and Acoustic Data Analysis

Keywords

animal-acoustic-signals audio-processing bioacoustics spectrogram streamline-analysis

Keywords from Contributors

behavior compendium research birdsong cultural-evolution phylogenetics acoustic-signals animal

Last synced: about 21 hours ago
JSON representation

Repository metadata

streamline acoustic analysis in R

README.Rmd

          ---
title: "warbleR: Streamline Bioacoustic Analysis"
output: github_document
editor_options: 
  chunk_output_type: console
---




[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![Dependencies](https://tinyverse.netlify.com/badge/warbleR)](https://cran.r-project.org/package=warbleR)
[![Project Status: Active  The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Licence](https://img.shields.io/badge/licence-GPL--2-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/warbleR)](https://cran.r-project.org/package=warbleR)
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/warbleR)](https://cranlogs.r-pkg.org/badges/grand-total/warbleR)
[![Codecov test coverage](https://codecov.io/gh/maRce10/warbleR/branch/master/graph/badge.svg)](https://app.codecov.io/gh/maRce10/warbleR?branch=master)



warbleR logo

[warbleR](https://cran.r-project.org/package=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](https://cran.r-project.org/package=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:
 
 - Diverse tools for measuring acoustic structure
 - 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](https://xeno-canto.org/) recordings
 - Explore, organize and manipulate multiple sound files
 - Detect signals automatically (in frequency and time) (but check the R package [ohun](https://docs.ropensci.org/ohun/) for a more thorough and friendly implementation)
 - 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.

## Installing

Install/load the package from CRAN as follows:

```{r, eval = FALSE}
install.packages("warbleR")

# load package
library(warbleR)
```

To install the latest developmental version from [github](https://github.com/) you will need the R package [remotes](https://cran.r-project.org/package=remotes):

```{r, eval = FALSE}
remotes::install_github("maRce10/warbleR")

# load package
library(warbleR)
```

## Usage

The package includes several vignettes explaining its main features. The [Intro to warbleR](https://marce10.github.io/warbleR/articles/warbleR.html) provides an overview of the package functionalities. The vignette [Annotation data format](https://marce10.github.io/warbleR/articles/annotation_data_format.html) gives a detailed description of the required format for input annotations. There are also three additional [package vignettes](https://marce10.github.io/warbleR/articles/) with examples on how to organize functions in an acoustic analysis workflow. 

A full description of the package (although a bit outdated) can be found in this [journal article](https://doi.org/10.1111/2041-210X.12624).

## Other packages

The packages [seewave](https://cran.r-project.org/package=seewave) and  [tuneR](https://cran.r-project.org/package=seewave) provide a huge variety of functions for acoustic analysis and manipulation. They moslty works on wave objects already imported into the R environment. The package  [baRulho](https://cran.r-project.org/package=baRulho) focuses on quantifying habitat-induced degradation of acoustic signals with data inputs and ouputs similar to those of [warbleR](https://cran.r-project.org/package=warbleR). The package [Rraven](https://cran.r-project.org/package=Rraven) facilitates the exchange of data between R and [Raven sound analysis software](https://www.ravensoundsoftware.com/) ([Cornell Lab of Ornithology](https://www.birds.cornell.edu/home)) and can be very helpful for incorporating Raven as the annotating tool into acoustic analysis workflow in R. The package [ohun](https://docs.ropensci.org/ohun/) works on automated detection of sound events, providing functions to diagnose and optimize detection routines. [dynaSpec](https://cran.r-project.org/package=seewave) is allows to create dynamic spectrograms (i.e. spectrogram videos).

## Citation

Please cite [warbleR](https://cran.r-project.org/package=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.

NOTE: please also cite the [tuneR](https://cran.r-project.org/package=tuneR) and [seewave](https://cran.r-project.org/package=seewave) packages if you use any spectrogram-creating or acoustic-measuring functions

        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 874
Total Committers: 7
Avg Commits per committer: 124.857
Development Distribution Score (DDS): 0.277

Commits in past year: 24
Committers in past year: 1
Avg Commits per committer in past year: 24.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
maRce10 m****7@g****m 632
Marcelo Araya-Salas m****a@u****r 188
gsmithvi g****i@g****m 49
maRce10 m****7@g****m 2
Ed Baker e****r@g****m 1
Andrew S a****e@g****m 1
Grace Smith Vidaurre g****e@M****l 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 65
Total pull requests: 12
Average time to close issues: 2 months
Average time to close pull requests: 1 day
Total issue authors: 46
Total pull request authors: 4
Average comments per issue: 1.85
Average comments per pull request: 0.08
Merged pull request: 10
Bot issues: 0
Bot pull requests: 0

Past year issues: 5
Past year pull requests: 0
Past year average time to close issues: 3 months
Past year average time to close pull requests: N/A
Past year issue authors: 3
Past year pull request authors: 0
Past year average comments per issue: 0.6
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/marce10/warbler

Top Issue Authors

  • maRce10 (15)
  • jkvrtilek (3)
  • madelynore (2)
  • axelsoundingwild (2)
  • auman-chan (2)
  • thk686 (1)
  • akroner1 (1)
  • choudavid0 (1)
  • ellurunaresh (1)
  • LittleAlle (1)
  • paddygoat (1)
  • marina-martin-maroto (1)
  • gauravsk (1)
  • dododave (1)
  • neon-ninja (1)

Top Pull Request Authors

  • gsvidaurre (9)
  • edwbaker (1)
  • maRce10 (1)
  • andrew-1234 (1)

Top Issue Labels

  • bug (1)

Top Pull Request Labels


Package metadata

cran.r-project.org: warbleR

Streamline Bioacoustic Analysis

  • Homepage: https://marce10.github.io/warbleR/
  • Documentation: http://cran.r-project.org/web/packages/warbleR/warbleR.pdf
  • Licenses: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
  • Latest release: 1.1.34 (published 3 months ago)
  • Last Synced: 2025-04-25T13:31:05.466Z (2 days ago)
  • Versions: 36
  • Dependent Packages: 3
  • Dependent Repositories: 6
  • Downloads: 75,565 Last month
  • Rankings:
    • Forks count: 3.597%
    • Stargazers count: 6.826%
    • Average: 9.276%
    • Dependent packages count: 10.87%
    • Dependent repos count: 11.889%
    • Downloads: 13.196%
  • Maintainers (1)

Dependencies

.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/tic.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v2 composite
  • pat-s/always-upload-cache v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-tinytex v2 composite
DESCRIPTION cran
  • NatureSounds * depends
  • R >= 3.2.1 depends
  • seewave >= 2.0.1 depends
  • tuneR * depends
  • RCurl * imports
  • Rcpp * imports
  • bioacoustics * imports
  • cli * imports
  • dtw * imports
  • fftw * imports
  • grDevices * imports
  • graphics * imports
  • knitr * imports
  • methods * imports
  • monitoR * imports
  • parallel * imports
  • pbapply * imports
  • rjson * imports
  • stats * imports
  • testthat >= 3.0.0 imports
  • utils * imports
  • Sim.DiffProc * suggests
  • ape * suggests
  • covr * suggests
  • ggplot2 * suggests
  • jpeg * suggests
  • kableExtra * suggests
  • leaflet * suggests
  • maps * suggests
  • png * suggests
  • pracma * suggests
  • rmarkdown * suggests
  • soundgen * suggests
  • wavethresh * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite

Score: 17.535499795392564