get_token: Check Protected Planet API Token

In FRBCesab/worldpa: An Interface to the World Database on Protected Areas (WDPA)

Description

This function checks if the user has stored a valid Protected Planet API token in the R environment file (.Renviron).

Usage

get_token(key = "WDPA_KEY")

Arguments

key	a character providing the WDPA token name stored in the .Renviron file. Default is WDPA_KEY.

Details

Before using this package for the first time, the user must follow these steps:

• Fill in the form available at: https://api.protectedplanet.net/request to obtain a personal API token;

• Store the token in the .Renviron file under the key WDPA_KEY. User can use the function usethis::edit_r_environ to open this file;

• Restart R.

Value

A vector of length one with the value of the API token.

Examples

## Not run: 
## Check if Protected Planet API token is stored ----
worldpa::get_token()

## End(Not run)

FRBCesab/worldpa documentation built on Feb. 26, 2021, 2:38 a.m.