search_variables: Serach for varaible codes.

Description Usage Arguments Details Value Examples

Description

Search for given phrase in variable names.

Usage

1
2
3
search_variables(name, subjectId = NULL, level = NULL, year = NULL,
  sort = c("id", "-id", "subjectId", "-subjectId"), lang = c("pl",
  "en"), ...)

Arguments

name

A phrase to search.

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", "name", "-name"

lang

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

...

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

Details

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

1
2
3
4
5
 ## Not run: 
    variables <- search_variables("samochody")
    variables <- search_variables("cars", lang  = "en")

## End(Not run)

KaniaKrzysztof/bdl documentation built on June 28, 2019, 8:09 p.m.