w_structure: Get the structure of a dataset

In rwebstat: Download Data from the Webstat API

Get the structure of a dataset

Description

Get the structure of a dataset

Usage

w_structure(
  dataset_name,
  language = "fr",
  option = "light",
  client_ID,
  base_url = "https://api.webstat.banque-france.fr/webstat-"
)

Arguments

dataset_name	Mandatory. String (must be entered between quotes.) The datasets codes can be determined using the w_datasets() function.
language	Optional. String. Defaults to "fr" (French). The only other available option is "en" (English). Determines the language of the metadata. Your Webstat "App" must be subscribed to the API in this language or you'll get a 501 http error.
option	Optional. 'light' or 'full'
client_ID	Optional. String. If you do not specify it when calling the function, it will check if a global variable called "webstat_client_ID" exists and use it. If not, you will be prompted. The easiest way is to save the client ID as a string in a "webstat_client_ID" global variable.
base_url	Optional. String. Defaults to "https://api.webstat.banque-france.fr/webstat-". For internal testing purposes only.

Value

a list of dataset structure

Examples

## Not run: 
w_structure("EXR")

## End(Not run)

rwebstat documentation built on June 7, 2023, 5:10 p.m.