wdpa_api_pa_search: WDPA API: protected areas search

View source: R/wdpa_api_pa_search.R

wdpa_api_pa_searchR Documentation

WDPA API: protected areas search

Description

WDPA API: protected areas search

Usage

wdpa_api_pa_search(marine = FALSE, country = NULL, designation = NULL,
  jurisdiciton = NULL, governance = NULL, iucn_category = NULL,
  geojson = FALSE, page = 1, per_page = 25, token = NULL, ...)

Arguments

marine

(logical) If TRUE returns all marine protected areas, paginated. If FALSE (default) returns all terrestrial protected areas, paginated.

country

(character) If set, returns all protected areas from the country with the given ISO3, paginated. By default, this is unset: protected areas from all countries are returned.

designation

(integer) If set, returns all protected areas designated with the given id, paginated. By default, this is unset: protected areas with all designations are returned.

governance

(integer) If set, returns all protected areas with the given governance id, paginated. By default, this is unset: protected areas with all governances are returned.

iucn_category

(integer) If set, returns all protected areas with the given IUCN category id, paginated. By default, this is unset: protected areas with all IUCN categories are returned.

geojson

(logical) If TRUE returns the GeoJSON representation of the geometry of the protected areas. Default: FALSE

page

(integer) Controls the returned page. Default: 1

per_page

(integer) Controls how many protected areas are returned per page. Default: 25. For performance reasons, the maximum value is 50.

token

(character) token. see rwdpa for help on tokens

...

curl options passed on to crul::HttpClient

jurisdiction

(integer) If set, returns all protected areas with the given jurisdiciton id, paginated. By default, this is unset: protected areas with all jurisdictions are returned.

Details

This function uses the Protected Planet API

Value

a data.frame

References

https://api.protectedplanet.net/documentation

Examples

## Not run: 
wdpa_api_pa_search()
wdpa_api_pa_search(per_page = 3)
wdpa_api_pa_search(country = "BEL")
wdpa_api_pa_search(iucn_category = 3)

## End(Not run)

ropenscilabs/rwdpa documentation built on May 18, 2022, 8:31 p.m.