README.Rmd

---
title: "NatureSounds"
output: github_document
editor_options: 
  chunk_output_type: console
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

[![lifecycle](https://img.shields.io/badge/lifecycle-maturing-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html) [![Dependencies](https://tinyverse.netlify.com/badge/NatureSounds)](https://cran.r-project.org/package=NatureSounds) [![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/https://img.shields.io/badge/licence-GPL--2-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![minimal R version](https://img.shields.io/badge/R%3E%3D-`r strsplit(gsub("depends: R \\(|\\)", "", grep("DEPENDS", ignore.case = TRUE, readLines(con = "./DESCRIPTION"), value = TRUE), ignore.case = TRUE), ",")[[1]][1]`-6666ff.svg)](https://cran.r-project.org/) [![packageversion](https://img.shields.io/badge/Package%20version-`r gsub("version: |version:", "", grep("version", ignore.case = TRUE, readLines(con = "./DESCRIPTION"), value = TRUE), ignore.case = TRUE)`-orange.svg?style=flat-square)](commits/develop) [![Last-changedate](https://img.shields.io/badge/last%20change-`r gsub('-', '--', Sys.Date())`-yellowgreen.svg)](/commits/master) [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/NatureSounds)](https://cran.r-project.org/package=NatureSounds)
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/NatureSounds)](https://cranlogs.r-pkg.org/badges/grand-total/NatureSounds)

<img src="vignettes/NatureSounds_sticker.png" alt="NatureSounds logo" align="right" width = "25%" height="25%"/>


`NatureSounds` is a package containing a collection of example animal sounds for bioacoustic analysis. The main goal is to provide example recordings of animal sounds to faciliate the development of bioacoustic tools in the R environment. When possible, selection tables with the time/frequency coordinates of the sounds in the example recordings will also be included.


Install/load the package from CRAN as follows:

```{r, eval = FALSE}

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

#load package
library(NatureSounds)

```

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}
# From github
remotes::install_github("maRce10/NatureSounds")

#load package
library(NatureSounds)

```

Please cite [NatureSounds](https://cran.r-project.org/package=NatureSounds) as follows:

Araya-Salas, M. (2018), *NatureSounds: a collection of animal sound for bioacoustic analysis in the R environment*. R package version 1.1.0.