In dhope/ARUtools: Tools for management of Acoustic Recording Unit (ARU) data

knitr::opts_chunk$set(
  collapse = TRUE,
  eval=F,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

ARUtools

The goal of ARUtools is to facilitate the processing of ARU data and subsampling of recordings. It remains a development version for now. What this means for you as a user is that function names and variable names may change between versions and some functions may become defunct.

Installation

You can install the current version of ARUtools from GitHub with:

# install.packages("remotes") # Uncomment if you don't have remotes installed.
remotes::install_github("dhope/ARUtools", build_vignettes=TRUE)

Learn to use

The easiest way to dig into using the ARUtools package is using the documentation webpage

There currently are four vignettes that will help you get up and running with cleaning ARU metadata

• Getting started with ARUtools
• Customizing clean_metadata()
• Dealing with timezones
• Working with spatial data

Provide feedback

If you run into problems or have ideas for extensions, please don't hesitate to submit an issue.

Motivation and limitations

This package initially started its life as a series of scripts to process recordings from multiple large projects around monitoring migratory bird populations in Ontario's North.

Moving from scripts to package stemmed from following the wise advice from Hadley Wickham:

A good rule of thumb is to consider writing a function whenever you've copied and pasted a block of code more than twice (i.e. you now have three copies of the same code).

With multiple projects, each with their own data issues, it became clear that this would either require copy/pasting a lot of code and likely break something or developing a series of functions that could be shared across projects (i.e. a package).

While that initial version of the code was usable by me and only me, if you're using the package, it is because of the fantastic work of Steffi LaZerte who translated my mess into the user-friendly functions you see today.

However, due to the variable nature of data management, it is possible that ARUtools may not work well for your project. If you run into issues, please do submit an issue.

There are also other good packages that may be of use to you:

• wildRtrax (R)
• seewave (R)
• emu (command line)
• SoX (command line)
• Sound-Extraction (python)

dhope/ARUtools documentation built on Jan. 18, 2024, 5:47 a.m.