ebirdnotable: Recent nearby notable observations

In ropensci/rebird: R Client for the eBird Database of Bird Observations

Recent nearby notable observations

Description

Returns the most recent notable observations by either latitude/longitude, hotspot or location ID, or particular region.

Usage

ebirdnotable(
  lat = NULL,
  lng = NULL,
  dist = NULL,
  locID = NULL,
  region = NULL,
  back = NULL,
  max = NULL,
  provisional = FALSE,
  hotspot = FALSE,
  simple = TRUE,
  sleep = 0,
  key = NULL,
  ...
)

Arguments

lat	Decimal latitude. value between -90.00 and 90.00, up to two decimal places of precision.
lng	Decimal longitude. value between -180.00 and 180.00, up to two decimal places of precision.
dist	Distance defining radius of interest from given lat/lng in kilometers (between 0 and 50, defaults to 25)
locID	Vector containing code(s) for up to 10 locations of interest.
region	Region code corresponding to selected region type. For supported region and coding, see https://confluence.cornell.edu/display/CLOISAPI/eBird-1.1-RegionCodeReference
back	Number of days back to look for observations (between 1 and 30, defaults to 14).
max	Maximum number of result rows to return in this request (between 1 and 10000, defaults to all).
provisional	Should flagged records that have not been reviewed be included? (defaults to FALSE)
hotspot	Should results be limited to sightings at birding hotspots? (defaults to FALSE).
simple	Logical. Whether to return a simple (TRUE, default) or detailed (FALSE) set of results fields.
sleep	Time (in seconds) before function sends API call (defaults to zero. Set to higher number if you are using this function in a loop with many API calls).
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 the collected information:

"speciesCode": species code

"comName": species common name

"sciName" species' scientific name

"locId": unique identifier for the location

"locName": location name

"obsDt": observation date formatted according to ISO 8601 (e.g. 'YYYY-MM-DD', or 'YYYY-MM-DD hh:mm'). Hours and minutes are excluded if the observer did not report an observation time.

"howMany": number of individuals observed, NA if only presence was noted

"lat": latitude of the location

"lng": longitude of the location

"obsValid": TRUE if observation has been deemed valid by either the

"obsReviewed": TRUE if observation has been reviewed, FALSE otherwise

"locationPrivate": TRUE if location is not a birding hotspot automatic filters or a regional viewer, FALSE otherwise

"subId": submission ID

"exoticCategory": Exotic category

"subnational2Code": county code (returned if simple=FALSE)

"subnational2Name": county name (returned if simple=FALSE)

"subnational1Code": state/province ISO code (returned if simple=FALSE)

"subnational1Name": state/province name (returned if simple=FALSE)

"countryCode": country ISO code (returned if simple=FALSE)

"countryName": country name (returned if simple=FALSE)

"userDisplayName": observer's eBird username (returned if simple=FALSE)

"obsID": observation ID (returned if simple=FALSE)

"checklistID": checklist ID (returned if simple=FALSE)

"presenceNoted": 'true' if user marked presence but did not count the number of birds. 'false' otherwise (returned if simple=FALSE)

"firstName": observer's first name (returned if simple=FALSE)

"lastName": observer's last name (returned if simple=FALSE)

Note

ebirdnotable requires that either latitude/longitude, location ID, or region be passed to the function. Multiple entries will result in the most specific being used. If none is supplied, defaults to lat/lng based on your IP.

Author(s)

Rafael Maia [e-mail], Sebastian Pardo [e-mail]

References

http://ebird.org/

Examples

## Not run: 
ebirdnotable(lat=42, lng=-70)
ebirdnotable(region='US', max=10)
ebirdnotable(region='US-OH')
ebirdnotable(region='CA-NS-HL')
ebirdnotable(locID = c('L275836','L124345'))

## End(Not run)

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