wdpa_search: Search protected areas based on attributes

Description Usage Arguments

View source: R/wdpa_areas.R

Description

Search protected areas based on attributes

Usage

1
2
3
wdpa_search(key = NULL, marine = NULL, country = NULL,
  designation = NULL, jurisdiction = NULL, governance = NULL,
  iucn_category = NULL, page = 1, per_page = 25)

Arguments

key

your API key as provided by Protected Planet

marine

boolean if TRUE returns all marine protected areas, if FALSE returns all the terrestrial ones, NULL by default returning all types of protected areas

country

3 characters string if set returns all protected areas from the given countries, by default unset and return PAs from all countries

designation

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

jurisdiction

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

governance

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

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.

page

Controls the returned page. Defaults to 1.

per_page

Controls how many protected areas are returned per page. Defaults to 25. For performance reasons, the maximum value is 50.


Rekyt/rwdpa documentation built on Dec. 27, 2017, 8:21 p.m.