cbs_get_toc: Retrieve a data.frame with requested cbs tables

In cbsodataR: Statistics Netherlands (CBS) Open Data API Client

Retrieve a data.frame with requested cbs tables

Description

cbs_get_toc by default a list of all tables and all columns will be retrieved. You can restrict the query by supplying multiple filter statements or by specifying the columns that should be returned.

Usage

cbs_get_toc(
  ...,
  convert_dates = TRUE,
  select = NULL,
  verbose = FALSE,
  cache = TRUE,
  base_url = getOption("cbsodataR.base_url", BASE_URL),
  include_ID = FALSE
)

Arguments

...	filter statement to select rows, e.g. Language="nl"
convert_dates	convert the columns with date-time information into DateTime (default TRUE)
select	character columns to be returned, by default all columns will be returned.
verbose	logical prints the calls to the webservice
cache	logical should the result be cached?
base_url	optionally specify a different server. Useful for third party data services implementing the same protocol.
include_ID	logical column needed by OData but with no current use.

Value

data.frame with identifiers, titles and descriptions of tables

Note

cbs_get_toc will cache results, so subsequent calls will be much faster.

Examples

## Not run: 

# get list of english tables
tables_en <- cbs_get_toc(Language="en")

# get list of dutch tables
tables_nl <- cbs_get_toc(Language="nl")
View(tables_nl)

## End(Not run)

cbsodataR documentation built on Sept. 25, 2024, 5:07 p.m.