-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
77 lines (42 loc) · 3.48 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
---
output: github_document
dev: cairo_png
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# soundscapeR <img src="man/figures/soundscaper_hexsticker.png" align="right" height="138.5"/>
<!-- badges: start -->
[](https://github.com/ThomasLuypaert/soundscapeR/actions/workflows/R-CMD-check.yaml)
[](https://codecov.io/gh/ThomasLuypaert/soundscapeR)
<a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public." /></a>
<!-- badges: end -->
[Thomas Luypaert](https://thomasluypaert.weebly.com/), Anderson S. Bueno, Tom Bradfer-Lawrence, Carlos A. Peres, Torbjørn Haugaasen
### A package for soundscape diversity quantification using Hill numbers
Welcome to the `soundscapeR` R-package! \
\
The goal of `soundscapeR` is to provide a standardized analytical pipeline for the computation, exploration, visualization, diversity quantification and comparison of soundscapes using Hill numbers. The package is designed to work with either continuous or regular-interval long-duration acoustic recordings, and can quantify the diversity of soundscapes using a range of different diversity types (richness, evenness & diversity), spatial scales (alpha, beta and gamma diversities), and spectro-temporal subsets.
If you are unfamiliar with the `soundscapeR` workflow, head on over to [Luypaert et al. (2022)](https://besjournals.onlinelibrary.wiley.com/doi/full/10.1111/2041-210X.13924) and take a look at the theoretical concepts. For an example of how the functions of the `soundscapeR` package can be used to elucidate ecological patterns, have a look at [Luypaert et al. (2023)](https://www.biorxiv.org/content/10.1101/2023.02.08.527658v1).
<img src="man/figures/soundscapeR_banner.PNG" align="left" />
### Installation
For the moment, the `soundscapeR` package is still under development, and can therefore only be downloaded from GitHub. To download the development version of our package, please use the code provided below.
```{r eval = FALSE}
## Install from github
## install.packages("remotes") ## if needed
remotes::install_github("ThomasLuypaert/soundscapeR", build_vignettes = TRUE)
```
### Workflow overview
A comprehensive introduction to `soundscapeR` and specific examples of package usage can be found at [thomasluypaert.github.io/soundscapeR_vignette](https://thomasluypaert.github.io/soundscapeR_vignette/). For a sneak peak at the workflow and the associated functions, have a look at this figure:
<img src="man/figures/Plot_1_soundscapeR_workflow.png" align="left" />
### Acknowledgements
We are thankful to Oliver Metcalf and Zuzana Burivalova for their input on the package.
### Contribution
The package was developed and written by [Thomas Luypaert](https://thomasluypaert.weebly.com/) with contributions from Anderson S. Bueno, Tom Bradfer-Lawrence, Carlos A. Peres and Torbjørn Haugaasen.
### Citation
**Luypaert et al. (2024)**. soundscapeR: an R-package for the exploration, visualization, diversity quantification and comparison of soundscapes.