soundscaper

This is the repository where the soundscapeR package lives

https://github.com/thomasluypaert/soundscaper

Science Score: 49.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
Found 2 DOI reference(s) in README
✓
Academic publication links
Links to: biorxiv.org, wiley.com
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.6%) to scientific vocabulary

Last synced: 6 months ago · JSON representation

Repository

This is the repository where the soundscapeR package lives

Basic Info

Host: GitHub
Owner: ThomasLuypaert
License: other
Language: R
Default Branch: master
Size: 335 MB

Statistics

Stars: 8
Watchers: 0
Forks: 0
Open Issues: 2
Releases: 0

Created over 5 years ago · Last pushed 11 months ago

Metadata Files

Readme License Citation Codemeta

README.Rmd

---
output: github_document
dev: cairo_png
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```



# soundscapeR 


[![R-CMD-check](https://github.com/ThomasLuypaert/soundscapeR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThomasLuypaert/soundscapeR/actions/workflows/R-CMD-check.yaml)
[![code coverage](https://codecov.io/gh/ThomasLuypaert/soundscapeR/branch/master/graph/badge.svg)](https://codecov.io/gh/ThomasLuypaert/soundscapeR)
[![Project Status: WIP  Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)


[Thomas Luypaert](https://thomasluypaert.weebly.com/), Anderson S. Bueno, Tom Bradfer-Lawrence, Carlos A. Peres, Torbjrn 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). 

 


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

 

### 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 Torbjrn Haugaasen.

### Citation

**Luypaert et al. (2024)**. soundscapeR: an R-package for the exploration, visualization, diversity quantification and comparison of soundscapes.

Owner

Name: Thomas Luypaert
Login: ThomasLuypaert
Kind: user
Location: Ås, Norway
Company: Norwegian University of Life Sciences

Repositories: 2
Profile: https://github.com/ThomasLuypaert

CodeMeta (codemeta.json)

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "soundscapeR",
  "description": "The soundscapeR package constitutes a standardized analytical pipeline for the exploration, computation, visualization, and comparison of soundscape diveristy using Hill numbers. The package is designed to work with either continuous or regular-interval long-duration acoustic recordings.",
  "name": "soundscapeR: Visualization And Quantification Of Soundscape Diversity Using Hill Numbers",
  "codeRepository": "https://github.com/ThomasLuypaert/soundscapeR",
  "issueTracker": "https://github.com/ThomasLuypaert/soundscapeR/issues",
  "license": "https://spdx.org/licenses/MIT",
  "version": "0.1.0",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.4.2 (2024-10-31 ucrt)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Thomas",
      "familyName": "Luypaert",
      "email": "thomas.luypaert@nmbu.no",
      "@id": "https://orcid.org/0000-0001-7491-7418"
    },
    {
      "@type": "Person",
      "givenName": "Anderson Saldanha",
      "familyName": "Bueno",
      "email": "buenoas@gmail.com",
      "@id": "https://orcid.org/0000-0001-7416-6626"
    },
    {
      "@type": "Person",
      "givenName": "Tom",
      "familyName": "Bradfer-Lawrence",
      "email": "tom.bradferlawrence@rspb.org.uk",
      "@id": "https://orcid.org/0000-0001-6045-4360"
    },
    {
      "@type": "Person",
      "givenName": "Carlos Augusto",
      "familyName": "Peres",
      "email": "carlos.a.peres@gmail.com",
      "@id": "https://orcid.org/0000-0002-1588-8765"
    },
    {
      "@type": "Person",
      "givenName": "Torbjrn",
      "familyName": "Haugaasen",
      "email": "torbjorn.haugaasen@nmbu.no",
      "@id": "https://orcid.org/0000-0003-0901-5324"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Thomas",
      "familyName": "Luypaert",
      "email": "thomas.luypaert@nmbu.no",
      "@id": "https://orcid.org/0000-0001-7491-7418"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=covr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "qs",
      "name": "qs",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=qs"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "plotly",
      "name": "plotly",
      "version": ">= 4.9.2.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=plotly"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "vdiffr",
      "name": "vdiffr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vdiffr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "crayon",
      "name": "crayon",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=crayon"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "assertthat",
      "name": "assertthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=assertthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ggrepel",
      "name": "ggrepel",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggrepel"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "lubridate",
      "name": "lubridate",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=lubridate"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "hms",
      "name": "hms",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=hms"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "version": ">= 3.5.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "stringr",
      "name": "stringr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=stringr"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "autothresholdr",
      "name": "autothresholdr",
      "version": ">= 1.3.5",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=autothresholdr"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "lutz",
      "name": "lutz",
      "version": ">= 0.3.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=lutz"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "reshape2",
      "name": "reshape2",
      "version": ">= 1.4.3",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=reshape2"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "viridis",
      "name": "viridis",
      "version": ">= 0.5.1",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=viridis"
    },
    "11": {
      "@type": "SoftwareApplication",
      "identifier": "scales",
      "name": "scales",
      "version": ">= 1.1.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=scales"
    },
    "12": {
      "@type": "SoftwareApplication",
      "identifier": "grid",
      "name": "grid",
      "version": ">= 2.6.3"
    },
    "13": {
      "@type": "SoftwareApplication",
      "identifier": "patchwork",
      "name": "patchwork",
      "version": ">= 1.2.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=patchwork"
    },
    "14": {
      "@type": "SoftwareApplication",
      "identifier": "utils",
      "name": "utils",
      "version": ">= 3.6.3"
    },
    "15": {
      "@type": "SoftwareApplication",
      "identifier": "suncalc",
      "name": "suncalc",
      "version": ">= 0.5.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=suncalc"
    },
    "16": {
      "@type": "SoftwareApplication",
      "identifier": "rlist",
      "name": "rlist",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rlist"
    },
    "17": {
      "@type": "SoftwareApplication",
      "identifier": "methods",
      "name": "methods"
    },
    "18": {
      "@type": "SoftwareApplication",
      "identifier": "magrittr",
      "name": "magrittr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=magrittr"
    },
    "19": {
      "@type": "SoftwareApplication",
      "identifier": "data.table",
      "name": "data.table",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=data.table"
    },
    "20": {
      "@type": "SoftwareApplication",
      "identifier": "vegan",
      "name": "vegan",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=vegan"
    },
    "21": {
      "@type": "SoftwareApplication",
      "identifier": "tidyr",
      "name": "tidyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tidyr"
    },
    "22": {
      "@type": "SoftwareApplication",
      "identifier": "seewave",
      "name": "seewave",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=seewave"
    },
    "23": {
      "@type": "SoftwareApplication",
      "identifier": "tuneR",
      "name": "tuneR",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tuneR"
    },
    "24": {
      "@type": "SoftwareApplication",
      "identifier": "Rcpp",
      "name": "Rcpp",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=Rcpp"
    },
    "25": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "26": {
      "@type": "SoftwareApplication",
      "identifier": "bioacoustics",
      "name": "bioacoustics",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=bioacoustics"
    },
    "27": {
      "@type": "SoftwareApplication",
      "identifier": "warbleR",
      "name": "warbleR",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=warbleR"
    },
    "28": {
      "@type": "SoftwareApplication",
      "identifier": "pracma",
      "name": "pracma",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=pracma"
    },
    "29": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 3.5.0"
    },
    "SystemRequirements": "C++17"
  },
  "fileSize": "426492.379KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2024",
      "author": [
        {
          "@type": "Person",
          "givenName": "Thomas",
          "familyName": "Luypaert"
        }
      ],
      "name": "{soundscapeR}: {P}ackage for the visualization and diversity quantification of soundscapes",
      "url": "https://github.com/ThomasLuypaert/soundscapeR",
      "description": "version 0.1.0"
    }
  ],
  "readme": "https://github.com/ThomasLuypaert/soundscapeR/blob/master/README.md",
  "contIntegration": [
    "https://github.com/ThomasLuypaert/soundscapeR/actions/workflows/R-CMD-check.yaml",
    "https://codecov.io/gh/ThomasLuypaert/soundscapeR"
  ]
}

GitHub Events

Total

Issues event: 2
Watch event: 3
Issue comment event: 1
Push event: 11

Last Year

Issues event: 2
Watch event: 3
Issue comment event: 1
Push event: 11

Dependencies

DESCRIPTION cran

R >= 3.5.0 depends
autothresholdr >= 1.3.5 imports
dplyr * imports
ggplot2 > 3.3.0 imports
grid >= 2.6.3 imports
hilldiv >= 1.5.1 imports
hms * imports
lubridate * imports
lutz >= 0.3.1 imports
magrittr * imports
methods * imports
patchwork >= 1.0.0 imports
photobiology >= 0.10.2 imports
plotly >= 4.9.2.1 imports
reshape2 >= 1.4.3 imports
rlist * imports
scales >= 1.1.0 imports
stringr * imports
suncalc >= 0.5.0 imports
utils >= 3.6.3 imports
viridis >= 0.5.1 imports
yaml >= 2.2.1 imports
assertthat * suggests
covr * suggests
crayon * suggests
geiger * suggests
here * suggests
limma * suggests
parallel * suggests
pracma * suggests
qs * suggests
sf * suggests
testthat >= 3.0.0 suggests
vdiffr * suggests

.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/pr-commands.yaml actions

actions/checkout v2 composite
r-lib/actions/pr-fetch v2 composite
r-lib/actions/pr-push v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v4 composite
actions/upload-artifact v4 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science