cbsODataAPI: Query CBS OData API

Description Usage Arguments Details Author(s) See Also Examples

View source: R/cbsODataAPI.R

Description

Retrieve information from CBS Open Data API

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
cbsODataAPI(api = stop("'api' must be provided"),
  DSD = stop("'DSD' must be provided"), scheme = NULL, filter = NULL,
  append = NULL, query = FALSE, curl = NULL)

cbsOdataDFgather(data = stop("'data' must be provided"))

cbsOdataDFtoXTS(data = stop("'data' must be provided"))

cbsODataTables(url = "https://opendata.cbs.nl/ODataCatalog/Tables",
  fields = c("Identifier", "Title", "Frequency", "Period"))

cbsODataChangeDates(str)

Arguments

api

an API address

DSD

a datastructure definition identified by the triplet [collection; country; indicator].

scheme

an API scheme. Available scheme "data".

filter

for scheme "data": a named list of filters passed to the API. The position of list items corresponds to the API filter dimensions. Each list item is either empty (no filter on dimension) or a character vector containing dimension members to be included in the results. Dimension members can be obtained from scheme="codelist" and a codelist item, e.g. "CL_ECO_ISIC4".

append

append string to the dimension url.

query

logical to return OData http url only.

curl

optional, CURL handle created with RCurl::getCurlHandle()

data

a data frame created with cbsODataAPI

url

location of table list XML document.

fields

character vector to extract content properties of entries.

str

a character string with CBS OData dates, e.g. "1995JJ00"

xml.list

a character string returned from

Details

Retrieve information from CBS Netherlands Statline Open Data API using JSON format.

Author(s)

Bo Werth <[email protected]>

See Also

https://github.com/object/Simple.OData.Client

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
api <- "https://opendata.cbs.nl/ODataApi/OData/"
DSD <- "82572ENG" # Input-Output: "83068ENG"

cbsODataAPI(api=api, DSD=DSD, scheme = NULL)
str(cbsODataAPI(api=api, DSD=DSD, scheme="SectorBranchesSIC2008", query=FALSE))
str(cbsODataAPI(api=api, DSD=DSD, scheme="TypedDataSet"))

## End(Not run)

bowerth/nsoApi documentation built on July 1, 2017, 11 p.m.