/arrR

:package: Individual-based simulation model of artificial reefs

Primary LanguageRGNU General Public License v3.0GPL-3.0

arrR | Artifical reefs in R

Development CI License
Project Status R-CMD-check License: GPL v3
Lifecycle: stable codecov DOI

The goal of arrR is to simulate seagrass primary production around artificial reefs (ARs). For a more detailed model description, please see vignette("general-background"). Please see vignette("get-started") for a short tutorial how to use arrR.

Citation

To cite arrR in a publication or acknowledge its use, please use the following citation information:

Esquivel, K.E., Hesselbarth, M.H.K., Allgeier, J.E., 2022. Mechanistic support for increased primary production around artificial reefs. Ecological Applications e2617. https://doi.org/10.1002/eap.2617

For more information, please see vignette("publication-record"). To get a BibTex entry, please use citation("arrR").

Installation

You can install arrR from GitHub with the following line of code. If you want to install the most recent development version, please specify the argument ref = "development" within the function.

# install.packages("remotes)
remotes::install_github(repo = "Allgeier-Lab/arrR", ref = "main")

Get started

Please see vignette("get-started") for a short tutorial how to use the arrR package.

Code of Conduct

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

To contribute to this project, please see the Contributing guidelines.

Contact

Questions or bugs? Please get in touch via mhk.hesselbarth<at>gmail.com or submit an issue here. We are always happy to hear your input!