runnbnurl: Run the constructed url and get data

In ropensci/rnbn: Access NBN Data

Run the constructed url and get data

Description

The URL to call a web-service is constructed using makenbnurl() This is run and, hopefully, returns a JSON object

Usage

runnbnurl(service = NULL, tvks = NULL, datasets = NULL, feature = NULL,
  startYear = NULL, endYear = NULL, list = NULL, VC = NULL,
  group = NULL, query = NULL, gridRef = NULL, polygon = NULL,
  attributes = FALSE, ...)

Arguments

service	the service you want to call. One of "obs" for the taxonObservations service, "feature" for the features service, "taxon" for the taxa service, "list" for listing services, "ancestry" for taxonomy service and "species" for the species service. The first letter is sufficient
tvks	a list of TVKs which are strings of 16 alphanumeric characters
datasets	a list of dataset keys which are strings of 8 alphanumeric characters
feature	a featureID which is a string of 8 alphanumeric characters
startYear	a 4 digit integer year
endYear	a 4 digit integer year
list	url segment as a string as required to append to the base url to give the list required as a part of the "list" service.
VC	a string giving a vice-county name (see listVCs)
group	a string giving the name of a group (see listGroups)
query	a string used to perform a taxa search
gridRef	a string giving a gridreference in which to search for occurrences
polygon	A WKT (Well-Known Text) polygon string. Note that polygons containing many verticies (>100) are likely to create queries that exceed the NBN character limit
attributes	if TRUE then attribute data is returned
...	Further named parameters passed on to GET

Value

a JSON object resulting from the call

Author(s)

Stuart Ball, JNCC [e-mail]

Examples

## Not run:  
 json <- runnbnurl(service="obs", tvks="NBNSYS0000007073", datasets="SGB00001",
                   startYear="1990", endYear="2010")

## End(Not run)

ropensci/rnbn documentation built on May 18, 2022, 6:42 p.m.