-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.Rmd
65 lines (44 loc) · 3.27 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# GeoPressureR <img src="man/figures/logo.png" align="right" height="139"/>
<!-- badges: start -->
[](https://doi.org/10.5281/zenodo.7754457)
[](/~https://github.com/Rafnuss/GeoPressureR/actions/workflows/R-CMD-check.yaml)
[](/~https://github.com/Rafnuss/GeoPressureR/actions/workflows/pkgdown.yaml)
[](https://app.codecov.io/gh/Rafnuss/GeoPressureR?branch=master)
[](/~https://github.com/Rafnuss/GeoPressureR/actions/workflows/lint.yaml)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- 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](https://doi.org/10.1111/2041-210X.14043)) and Nussbaumer et al. ([2023b](https://doi.org/10.1111/2041-210X.14082)).
## Installation
The best way to install the GeoPressureR package is through Github
``` r
# install.packages("pak")
pak::pkg_install("Rafnuss/GeoPressureR")
```
## Learn how to use GeoPressureR
The [GeoPressureManual](https://raphaelnussbaumer.com/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://raphaelnussbaumer.com/GeoPressureManual/"><img src="/~https://github.com/Rafnuss/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](/~https://github.com/Rafnuss/GeoPressureTemplate), a [github template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-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/Rafnuss/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?
Get citation information in R doing `citation("GeoPressureR")`.
Make sure to cite the correct reference (R package, papers of the underlying method and/or user guide) according to your use.