spatialsearch {rvertnet} | R Documentation |
Find records within some distance of a point given latitude and longitude.
Description
Searches by decimal latitude and longitude to return any occurrence record within the input distance (radius) of the input point.
Usage
spatialsearch(
lat,
long,
radius,
limit = 1000,
compact = TRUE,
messages = TRUE,
...
)
Arguments
lat |
(numeric) Latitude of the central point, in decimal degrees required. |
long |
(numeric) Longitude of the central point, in decimal degrees required. |
radius |
(numeric) Radius to search, in meters. There is no default value for this parameter. required. |
limit |
(integer) Limit on the number of records returned. If >1000
results, we use a cursor internally, but you should still get up to the
results you asked for. See also |
compact |
(logical) Return a compact data frame. default: |
messages |
(logical) Print progress and information messages.
Default: |
... |
Curl arguments passed on to crul::HttpClient |
Details
spatialsearch()
finds all records of any taxa having
decimal lat/long coordinates within a given radius (in meters) of
your coordinates.
Value
A list with two slots:
meta: a named list of metadata for the search results
data: a data frame of search results, columns vary
References
https://github.com/VertNet/webapp/wiki/The-API-search-function
Examples
## Not run:
res <- spatialsearch(lat = 33.529, long = -105.694, radius = 2000,
limit = 10)
# Pass in curl options for curl debugging
out <- spatialsearch(lat = 33.529, long = -105.694, radius = 2000,
limit = 10, verbose = TRUE)
## End(Not run)