-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
67 lines (48 loc) · 3.3 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
65
66
67
---
output:
rmarkdown::github_document:
html_preview: no
---
<!--- README.md is generated from README.Rmd. Please edit that file -->
# raptr: Representative and Adequate Prioritization Toolkit in R
[![lifecycle](https://img.shields.io/badge/Lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![R-CMD-check-Ubuntu](https://img.shields.io/github/actions/workflow/status/jeffreyhanson/raptr/R-CMD-check-ubuntu.yaml?branch=master&label=Ubuntu)](https://github.com/jeffreyhanson/raptr/actions)
[![R-CMD-check-Windows](https://img.shields.io/github/actions/workflow/status/jeffreyhanson/raptr/R-CMD-check-windows.yaml?branch=master&label=Windows)](https://github.com/jeffreyhanson/raptr/actions)
[![R-CMD-check-macOS](https://img.shields.io/github/actions/workflow/status/jeffreyhanson/raptr/R-CMD-check-macos.yaml?branch=master&label=macOS)](https://github.com/jeffreyhanson/raptr/actions)
[![R-CMD-check-Fedora](https://img.shields.io/github/actions/workflow/status/jeffreyhanson/raptr/R-CMD-check-fedora.yaml?branch=master&label=Fedora)](https://github.com/jeffreyhanson/raptr/actions)
[![Documentation](https://img.shields.io/github/actions/workflow/status/jeffreyhanson/raptr/documentation.yaml?branch=master&label=Documentation)](https://github.com/jeffreyhanson/raptr/actions)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/raptr)](https://CRAN.R-project.org/package=raptr)
Biodiversity is in crisis. The overarching aim of conservation is to preserve biodiversity patterns and processes. To this end, protected areas are established to buffer species and preserve biodiversity processes. But resources are limited and so protected areas must be cost-effective. This package contains tools to generate plans for protected areas (prioritizations), using spatially explicit targets for biodiversity patterns and processes. To obtain solutions in a feasible amount of time, this package uses the commercial Gurobi software package (obtained from <https://www.gurobi.com/>). For more information on using this package, see our paper published in Methods in Ecology and Evolution (DOI: 10.1111/2041-210X.12862).
## Installation
This package depends on several packages which can be difficult to install under Linux and Mac operating systems.
Linux (Ubuntu) users can install them typing the following code into the terminal:
```
sudo apt-get update
sudo apt-get install libgdal-dev
sudo apt-get install libproj-dev
sudo apt-get build-dep r-cran-rgl
```
Mac OSX users can install them using the code below.
```
brew install Caskroom/cask/xquartz
brew install gdal
```
To install the [latest official version on CRAN](https://CRAN.R-project.org/package=raptr), use the following R code.
```{r, eval = FALSE}
install.packages("raptr")
```
To install the [development version on GitHub](https://github.com/jeffreyhanson/raptr), use the following R code.
```{r, eval = FALSE}
if (!require("remotes")) install.packages("remotes")
remotes:::install_github("jeffreyhanson/raptr")
```
Once this package has been installed, you can read through the vignette for a tutorial on how to use it.
[View it here](http://jeffrey-hanson.com/raptr/articles/raptr.html), or by running the R code below.
```{r, eval = FALSE}
# open vignette in web browser
vignette("raptr", package = "raptr")
```
## Citation
```{r}
citation("raptr")
```