-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.Rmd
104 lines (68 loc) · 3.11 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
---
title: "worldpa"
author: "Nicolas Casajus"
date: "`r Sys.Date()`"
output:
md_document:
variant: gfm
toc: false
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
worldpa <img src="man/figures/hexsticker.png" height="120" align="right"/>
=========================================================
<!-- badges: start -->
[](https://github.com/FRBCesab/worldpa/actions)
[](https://CRAN.R-project.org/package=worldpa)
[](https://www.repostatus.org/#active)
[](http://www.gnu.org/licenses/gpl.html)
[](https://zenodo.org/badge/latestdoi/221718108)
<!-- badges: end -->
Overview
--------
This R package is an interface to the World Database on Protected Areas (WDPA)
hosted on the Protected planet website
([https://www.protectedplanet.net](https://www.protectedplanet.net)). This
package is freely released by the
[FRB-CESAB](https://www.fondationbiodiversite.fr/en/about-the-foundation/le-cesab/)
and allows user to download spatial shapefiles (`simple features`) of protected
areas (PA) for world countries using the WDPA API
([https://api.protectedplanet.net](https://api.protectedplanet.net)).
Terms and conditions
--------
You must ensure that the following citation is always clearly reproduced in any
publication or analysis involving the Protected Planet Materials in any derived
form or format:
> UNEP-WCMC and IUCN (`YEAR`) Protected Planet: The World Database on Protected
Areas (WDPA). Cambridge, UK: UNEP-WCMC and IUCN. Available at:
www.protectedplanet.net (dataset downloaded the `YEAR/MONTH`).
For further details on terms and conditions of the WDPA usage, please visit the
page:
[https://www.protectedplanet.net/c/terms-and-conditions](https://www.protectedplanet.net/c/terms-and-conditions).
Prerequisites
--------
This package uses the WDPA API to access data on world protected areas. You must
first have obtained a Personal API Token by filling in the form available at:
[https://api.protectedplanet.net/request](https://api.protectedplanet.net/request).
Then follow these instructions to store this token:
[Managing WDPA API Token](https://frbcesab.github.io/worldpa/articles/worldpa.html#managing-wdpa-api-token).
Installation
--------
You can install the development version from [GitHub](https://github.com/) with:
```{r eval=FALSE}
# install.packages("remotes")
remotes::install_github("FRBCesab/worldpa")
```
:warning: **Note:** Build the vignette only if you already have stored the token.
Getting started
--------
Browse the [**vignette**](https://frbcesab.github.io/worldpa/articles/worldpa.html)
to get started.
Functions documentation can be found at:
[https://frbcesab.github.io/worldpa/reference](https://frbcesab.github.io/worldpa/reference/).