<!-- README.md is generated from README.Rmd. Please edit that file and use devtools::build_readme() -->

GeoPressureR <img src="man/figures/logo.png" align="right" height="139"/>

<!-- badges: start -->

<!-- badges: end -->

GeoPressureR is a R package which help researchers construct the trajectory of a bird equipped with an atmospheric pressure sensor. The package is a direct implementation of methods presented in Nussbaumer et al. (2023a) and Nussbaumer et al. (2023b).

Installation

The best way to install the GeoPressureR package is through Github

# install.packages("pak")
pak::pkg_install("GeoPressure/GeoPressureR")

# Development version:
pak::pkg_install("GeoPressure/GeoPressureR@dev")

Learn how to use GeoPressureR

The GeoPressureManual is a great place to start learning about how to use GeoPressureR.

Using the examples, this user guide takes you through each step of the analysis in detail.

<p align="center">

<a href="https://geopressure.org/GeoPressureManual/"><img src="https://github.com/GeoPressure/GeoPressureManual/raw/main/assets/cover.png" style="margin: 0 1rem 0 1rem;box-shadow: 0 .5rem 1rem rgba(0,0,0,.15);" align="center" width="250" height="328"></a>

</p>

Start your own analysis

Once you are familiar with the workflow of the method and want to start your own study, we suggest you use GeoPressureTemplate, a github template repository which provides a standard code structure for your analysis.

Using this standardized code structure you will help you on many aspect: code sharing and troubleshooting, data archiving, work reproducibility.

Cheatsheet

<a href="https://github.com/GeoPressure/GeoPressureR/raw/master/man/figures/cheatsheet.pdf" target="_blank"> <img src="man/figures/cheatsheet-01.png" width="350"/> <img src="man/figures/cheatsheet-02.png" width="350"/> </a>

How to cite?

Make sure to cite the correct reference (R package, papers of the underlying methods and/or user manual) according to your use:

Nussbaumer, R., & Gravey, M. (2022). GeoPressureR: Global positioning by atmospheric pressure. Zenodo. https://doi.org/10.5281/zenodo.7754457. Available at: https://github.com/GeoPressure/GeoPressureR

Nussbaumer, R., Gravey, M., Briedis, M., & Liechti, F. (2023). Global positioning with animal-borne pressure sensors. Methods in Ecology and Evolution, 14(4), 1104–1117. https://doi.org/10.1111/2041-210X.14043

Nussbaumer, R., Gravey, M., Briedis, M., Liechti, F., & Sheldon, D. (2023). Reconstructing bird trajectories from pressure and wind data using a highly optimised hidden Markov model. Methods in Ecology and Evolution, 14(4), 1–32. https://doi.org/10.1111/2041-210X.14082

Nussbaumer, R., & Nussbaumer, A. (2024). GeoPressureManual: Learn how to use GeoPressureR with examples. Zenodo. https://doi.org/10.5281/zenodo.10799355. Available at: https://github.com/GeoPressure/GeoPressureManual

Get citation information in R with citation("GeoPressureR").