get_variables {bdl}R Documentation

Get variable id codes.

Description

Retrieve variables for given subjectId.

Usage

get_variables(
  subjectId,
  level = NULL,
  year = NULL,
  sort = c("id", "-id", "subjectId", "-subjectId"),
  lang = c("pl", "en"),
  ...
)

Arguments

subjectId

A subject id code. If not specified returns all top level subjects. Use search_subjects or get_subjects to get subject id.

level

A number from 0 to 6, filters the returned unit by its level. If NULL (default) no level filters apply. Use get_levels to find more info.

year

A vector of years. If NULL (default) returns data for all available years.

sort

A type of sorting, "id" (default), "-id", "subjectId", "-subjectId"

lang

A language of returned data, "pl" (default), "en"

...

Other arguments passed on to GET. For example a proxy parameters, see details.

Details

Variables for specified subject optionally filtered by level and year.

To use a proxy to connect, a use_proxy can be passed to GET. For example get_request(id, filters, config = httr::use_proxy(url, port, username, password)).

Value

A dataset as a tibble.

Examples

    # get_variables("P2425")

[Package bdl version 1.0.3 Index]