Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.55 KB

README.md

File metadata and controls

68 lines (51 loc) · 2.55 KB
Raw

worldpa

R-CMD-check CRAN status Project Status: Active License GPL-3 DOI

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). This package is freely released by the FRB-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).

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.

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. Then follow these instructions to store this token: Managing WDPA API Token.

Installation

You can install the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("FRBCesab/worldpa")

⚠️ Note: Build the vignette only if you already have stored the token.

Getting started

Browse the vignette to get started.

Functions documentation can be found at: https://frbcesab.github.io/worldpa/reference.