README.md

In mabecker89/wildRtrax: Environmental sensor data management and analytics to and from WildTrax

wildRtrax

Overview

wildRtrax (pronounced wild-R-tracks) is an R package containing functions to help manage and analyze environmental sensor data. It helps to simplify the entire data life cycle by offering tools for data pre-processing, wrangling, and analysis, facilitating seamless data transfer to and from WildTrax. With wildRtrax, users can effortlessly establish end-to-end workflows and ensure reproducibility in their analyses. By providing a consistent and organized framework, the package promotes transparency and integrity in research, making it effortless to share and replicate results.

Installation

You can install version 1.1.0 of wildRtrax directly from this repository with:

# install.packages("remotes")
remotes::install_github("ABbiodiversity/wildRtrax")

The development version of this package contains experimental features and recent fixes. It can be installed with:

remotes::install_github("ABbiodiversity/wildRtrax@development)

The development version of the package will be periodically merged and will be reflected in the Changelogs.

Usage

All functions begin with a wt_* prefix. Column names and metadata align with the WildTrax infrastructure. The goal is to follow the work flow of pre-processing, linking with WildTrax, download and analysis. Some functions are built specifically for ARUs :sound:, cameras :camera: or point counts :bird:, while others are used for all sensors. :bat: denotes ultrasonic functionalities.

• Pre-process acoustic data
• wt_audio_scanner() :sound: :bat:
• wt_run_ap() :sound:
• wt_glean_ap() :sound:
• wt_signal_level() :sound:
• wt_chop() :sound: :bat:
• wt_make_aru_tasks() :sound: :bat:
• wt_songscope_tags() :sound:
• wt_kaleidoscope_tags() :sound: :bat:
• Download data from WildTrax
• wt_auth() :camera: :sound: :bird: :bat:
• wt_get_download_summary() :camera: :sound: :bird: :bat:
• wt_download_report() :camera: :sound: :bird: :bat:
  • Available reports: main, project, location, recording, image_set, image, tag, point_count, megadetector, megaclassifer, birdnet
• wt_get_species() :camera: :sound: :bird: :bat:
• wt_download_tags() :sound: :bat:
• Analyze data
• wt_summarise_cam() :camera:
• wt_ind_detect() :camera:
• Convenience functions
• wt_location_distances() :sound: :camera: :bird: :bat:
• wt_tidy_species() :sound: :camera: :bird: :bat:
• wt_replace_tmtt() :sound:
• wt_make_wide() :sound: :bird: :bat:
• wt_format_occupancy() :sound: :bird:
• wt_qpad_offsets() :sound: :bird:

Issues

To report bugs, request additional features, or get help using the package, please file an issue.

Contributors

• wildRtrax is authored, created and maintained by Alexander G. MacPhail and Marcus Becker, with significant contributions from Dr. Elly Knight and Dr. Richard Hedley. We encourage ongoing contributions and collaborations to improve the package into the future. The Alberta Biodiversity Monitoring Institute provides ongoing support, development and funding.

License

This R package is licensed under MIT license© 2023 Marcus Becker, Alex MacPhail, Elly Knight and the Alberta Biodiversity Monitoring Institute.

Code of Conduct

Please note that wildRtrax is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

mabecker89/wildRtrax documentation built on Feb. 5, 2024, 8:50 a.m.