Git Product home page Git Product logo

wildrtrax's Introduction

wildRtrax

Lifecycle: stable R-CMD-check codecov CRAN status

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 the most recent version 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 ๐Ÿ”‰, cameras ๐Ÿ“ท or point counts ๐Ÿฆ, while others are used for all sensors. ๐Ÿฆ‡ denotes ultrasonic functionalities.

  • Pre-process acoustic data
    • wt_audio_scanner() ๐Ÿ”‰ ๐Ÿฆ‡
    • wt_run_ap() ๐Ÿ”‰
    • wt_glean_ap() ๐Ÿ”‰
    • wt_signal_level() ๐Ÿ”‰
    • wt_chop() ๐Ÿ”‰ ๐Ÿฆ‡
    • wt_make_aru_tasks() ๐Ÿ”‰ ๐Ÿฆ‡
    • wt_songscope_tags() ๐Ÿ”‰
    • wt_kaleidoscope_tags() ๐Ÿ”‰ ๐Ÿฆ‡
  • Download data from WildTrax
    • wt_auth() ๐Ÿ“ท ๐Ÿ”‰ ๐Ÿฆ ๐Ÿฆ‡
    • wt_get_download_summary() ๐Ÿ“ท ๐Ÿ”‰ ๐Ÿฆ ๐Ÿฆ‡
    • wt_download_report() ๐Ÿ“ท ๐Ÿ”‰ ๐Ÿฆ ๐Ÿฆ‡
      • Available reports: main, project, location, recording, image_set, image, tag, point_count, megadetector, megaclassifer, birdnet
    • wt_get_species() ๐Ÿ“ท ๐Ÿ”‰ ๐Ÿฆ ๐Ÿฆ‡
    • wt_download_tags() ๐Ÿ”‰ ๐Ÿฆ‡
  • Analyze data
    • wt_summarise_cam() ๐Ÿ“ท
    • wt_ind_detect() ๐Ÿ“ท
  • Convenience functions
    • wt_location_distances() ๐Ÿ”‰ ๐Ÿ“ท ๐Ÿฆ ๐Ÿฆ‡
    • wt_tidy_species() ๐Ÿ”‰ ๐Ÿ“ท ๐Ÿฆ ๐Ÿฆ‡
    • wt_replace_tmtt() ๐Ÿ”‰
    • wt_make_wide() ๐Ÿ”‰ ๐Ÿฆ ๐Ÿฆ‡
    • wt_format_occupancy() ๐Ÿ”‰ ๐Ÿฆ
    • wt_qpad_offsets() ๐Ÿ”‰ ๐Ÿฆ

Issues

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

Contributors

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.

wildrtrax's People

Contributors

agmacpha avatar mabecker89 avatar ecknight avatar vlucet avatar github-actions[bot] avatar see24 avatar cassstevenson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.