download_meta-deprecated: Dumps the meta data into a directory

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

Dumps the meta data into a directory

Description

This method is deprecated in favor of cbs_download_meta().

Usage

download_meta(
  id,
  dir = id,
  ...,
  verbose = FALSE,
  cache = FALSE,
  base_url = getOption("cbsodataR.base_url", BASE_URL)
)

Arguments

id	Id of CBS open data table (see cbs_get_toc())
dir	Directory in which data should be stored. By default it creates a sub directory with the name of the id
...	not used
verbose	Print extra messages what is happening.
cache	Should meta data be cached?
base_url	optionally allow to specify a different server. Useful for third party data services implementing the same protocol, see details.

Value

meta data object

Specify different server

Besides the official CBS data, there are also third party and preview dataservices implementing the same protocol. The base_url parameter allows to specify a different server. The base_url can either be specified explicitly or set globally with with options(cbsodataR.base_url = "http://example.com"). Some further tweaking may be necessary for third party services, a download url is constructed using: either with:

• ⁠<base_url>/<BULK>/<id>/...⁠ for data

• ⁠<base_url>/<API>/<id>/?$format=json⁠ for metadata

Default values for BASEURL, BULK and API are set in the package options, but can be changed with:

options(
 cbsodataR.base_url = "https://opendata.cbs.nl",
 cbsodataR.BULK = "ODataFeed/odata",
 cbsodataR.API = "ODataAPI/odata"
)

which are the default values set in the package.

See Also

Other meta data: cbs_add_date_column(), cbs_add_label_columns(), cbs_add_unit_column(), cbs_get_meta()

Other download: cbs_download_data(), cbs_download_table()

edwindj/cbsodataR documentation built on Oct. 17, 2024, 3:35 a.m.