ebirdsubregionlist: List sub-regions within a specified region.

View source: R/ebirdsubregionlist.R

ebirdsubregionlistR Documentation

List sub-regions within a specified region.

Description

List sub-regions within a specified region.

Usage

ebirdsubregionlist(
  regionType = c("country", "subnational1", "subnational2"),
  parentRegionCode,
  key = NULL,
  ...
)

Arguments

regionType

The type of region to search for. Must be one of 'country', 'subnational1' or 'subnational2'.

parentRegionCode

The region to search within. Must be a valid country or subnational1 code. If ‘regionType' is ’country' then this parameter is ignored (since the search will automatically be world-wide).

key

eBird API key. You can obtain one from https://ebird.org/api/keygen. We strongly recommend storing it in your .Renviron file as an environment variable called EBIRD_KEY.

...

Curl options passed on to GET

Value

A data.frame containing:

"code": eBird code for the subregion

"name": full name for the subregion

Author(s)

David Bradnum dbradnum@gmail.com

References

http://ebird.org/

Examples

## Not run: 
ebirdsubregionlist("country")
ebirdsubregionlist("subnational1", "US")
ebirdsubregionlist("subnational2", "US-NY")

## End(Not run)

ropensci/rebird documentation built on Nov. 27, 2024, 9:47 p.m.