birdnetr

This is a wrapper for the birdnet Python package for automated bird sound ID

https://github.com/birdnet-team/birdnetr

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (19.0%) to scientific vocabulary

Keywords

bioacoustics birds sound
Last synced: 10 months ago · JSON representation

Repository

This is a wrapper for the birdnet Python package for automated bird sound ID

Basic Info
Statistics
  • Stars: 21
  • Watchers: 9
  • Forks: 1
  • Open Issues: 2
  • Releases: 7
Topics
bioacoustics birds sound
Created over 2 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog License Code of conduct

README.md

birdnetR birdnetR website

Lifecycle: experimental R-CMD-check CRAN status <!-- badges: end -->

birdnetR integrates BirdNET, a state‐of‐the‐art deep learning classifier for automated (bird) sound identification, into an R-workflow. This package will simplify the analysis of (large) audio datasets from bioacoustic projects, allowing researchers to easily apply machine learning techniques—even without a background in computer science.

birdnetR is an R wrapper around the birdnet Python package. It provides the core functionality to analyze audio using the pre-trained 'BirdNET' model or a custom classifier, and to predict bird species occurrence based on location and week of the year. However, it does not include all the advanced features available in the BirdNET Analyzer. For advanced applications, such as training custom classifiers and validation, users should use the 'BirdNET Analyzer' directly. birdnetR is under active development, and changes may affect existing workflows.

Installation

Install the released version from CRAN:

r install.packages("birdnetR")
or install the development version from GitHub with:

r pak::pak("birdnet-team/birdnetR")

Note
Python dependencies are installed on demand, meaning they are installed when you use them for the first time. This will result in longer initial setup.

Example use

This is a simple example using the tflite BirdNET model to predict species in an audio file.

```r

Load the package

library(birdnetR)

Initialize a BirdNET model

model <- birdnetmodeltflite()

Path to the audio file (replace with your own file path)

audio_path <- system.file("extdata", "soundscape.mp3", package = "birdnetR")

Predict species within the audio file

predictions <- predictspeciesfromaudiofile(model, audio_path)

Get most probable prediction within each time interval

gettopprediction(predictions)

```

Citation

Feel free to use birdnetR for your acoustic analyses and research. If you do, please cite as:

bibtex @article{kahl2021birdnet, title={BirdNET: A deep learning solution for avian diversity monitoring}, author={Kahl, Stefan and Wood, Connor M and Eibl, Maximilian and Klinck, Holger}, journal={Ecological Informatics}, volume={61}, pages={101236}, year={2021}, publisher={Elsevier} }

License

Please ensure you review and adhere to the specific license terms provided with each model. Note that educational and research purposes are considered non-commercial use cases.

Funding

This project is supported by Jake Holshuh (Cornell class of '69) and The Arthur Vining Davis Foundations. Our work in the K. Lisa Yang Center for Conservation Bioacoustics is made possible by the generosity of K. Lisa Yang to advance innovative conservation technologies to inspire and inform the conservation of wildlife and habitats.

The development of BirdNET is supported by the German Federal Ministry of Education and Research through the project “BirdNET+” (FKZ 01|S22072). The German Federal Ministry for the Environment, Nature Conservation and Nuclear Safety contributes through the “DeepBirdDetect” project (FKZ 67KI31040E). In addition, the Deutsche Bundesstiftung Umwelt supports BirdNET through the project “RangerSound” (project 39263/01).

Partners

BirdNET is a joint effort of partners from academia and industry. Without these partnerships, this project would not have been possible. Thank you!

Our partners

Owner

  • Name: BirdNET-Team
  • Login: birdnet-team
  • Kind: organization
  • Location: Germany

GitHub Events

Total
  • Create event: 6
  • Release event: 3
  • Issues event: 15
  • Watch event: 7
  • Delete event: 4
  • Issue comment event: 10
  • Push event: 50
  • Pull request event: 6
Last Year
  • Create event: 6
  • Release event: 3
  • Issues event: 15
  • Watch event: 7
  • Delete event: 4
  • Issue comment event: 10
  • Push event: 50
  • Pull request event: 6

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 171
  • Total Committers: 4
  • Avg Commits per committer: 42.75
  • Development Distribution Score (DDS): 0.234
Past Year
  • Commits: 76
  • Committers: 2
  • Avg Commits per committer: 38.0
  • Development Distribution Score (DDS): 0.316
Top Committers
Name Email Commits
fegue f****r@g****m 131
Sunny Tseng s****g@g****m 24
Stefan Kahl k****t@h****e 15
Melissa Weidlich-Rau 1****x 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 20
  • Total pull requests: 12
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 8 days
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 1.05
  • Average comments per pull request: 1.08
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 11
  • Pull requests: 8
  • Average time to close issues: 2 months
  • Average time to close pull requests: 5 days
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 1.09
  • Average comments per pull request: 0.63
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • fegue (17)
  • jaymwin (1)
  • vjjan91 (1)
  • r02ls22 (1)
Pull Request Authors
  • fegue (15)
  • SunnyTseng (2)
Top Labels
Issue Labels
enhancement (2)
Pull Request Labels

Packages

  • Total packages: 3
  • Total downloads:
    • cran 247 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 15
  • Total maintainers: 1
proxy.golang.org: github.com/birdnet-team/birdnetr
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
proxy.golang.org: github.com/birdnet-team/birdnetR
  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
cran.r-project.org: birdnetR

Deep Learning for Automated (Bird) Sound Identification

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 247 Last month
Rankings
Dependent packages count: 26.7%
Dependent repos count: 32.9%
Average: 48.7%
Downloads: 86.7%
Last synced: 10 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 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
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • reticulate * imports
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests