| Type: | Package |
| Title: | Interface and Tools for 'BDL' API |
| Version: | 1.0.5 |
| Description: | Interface to Local Data Bank ('Bank Danych Lokalnych' - 'bdl') API https://api.stat.gov.pl/Home/BdlApi?lang=en with set of useful tools like quick plotting and map generating using data from bank. |
| License: | GPL-3 |
| Depends: | R (≥ 3.5.0) |
| Imports: | methods, magrittr, tibble, jsonlite, httr, dplyr, tidyr, utils, stats, ggplot2, ggpubr, randomcoloR, purrr, sf, tmaptools, tmap, progress |
| Encoding: | UTF-8 |
| Suggests: | knitr, rmarkdown, testthat |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Repository: | CRAN |
| RoxygenNote: | 7.2.2 |
| URL: | https://statisticspoland.github.io/R_Package_to_API_BDL/ |
| BugReports: | https://github.com/statisticspoland/R_Package_to_API_BDL/issues |
| Packaged: | 2023-02-24 09:04:22 UTC; Aemaful |
| Author: | Marzena Szpadel [aut], Krzysztof Kania [aut, cre], Statistics Poland [cph, fnd] |
| Maintainer: | Krzysztof Kania <contact@krzysztofkania.com> |
| Date/Publication: | 2023-02-24 15:00:02 UTC |
bdl: Interface and Tools for 'BDL' API
Description
Interface to Local Data Bank ('Bank Danych Lokalnych' - 'bdl') API https://api.stat.gov.pl/Home/BdlApi?lang=en with set of useful tools like quick plotting and map generating using data from bank.
Package options
- 'bdl.api_private_key'
String with BDL API key which you can get at https://api.stat.gov.pl/Home/BdlApi?lang=en Example:
options(bdl.api_private_key = "11111111-2222-3333-4444-555555555555")
Author(s)
Maintainer: Krzysztof Kania contact@krzysztofkania.com
Authors:
Marzena Szpadel M.Szpadel@stat.gov.pl
Other contributors:
Statistics Poland [copyright holder, funder]
See Also
Useful links:
Information about attribute
Description
Retrieve information about attribute.
Usage
attribute_info(attrId, lang = c("pl", "en"), ...)
Arguments
attrId |
A single attribute id.Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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 named list.
Examples
# attribute_info("1")
Generate quick map
Description
Generate given NUTS level map with data from given variable
Usage
generate_map(
varId,
year,
unitLevel = 2,
unitParentId = NULL,
aggregateId = NULL,
palette = "Blues",
style = NULL,
n = 10,
names = FALSE,
borderLevel = NULL,
lang = c("pl", "en"),
...
)
Arguments
varId |
A single variable Id.
Use |
year |
A single year from 2010-2023 range. |
unitLevel |
A map and data NUTS level - number from 1 to 6. Use |
unitParentId |
A 12 character NUTS id code of interested unit. Use |
aggregateId |
An aggregate id. Use |
palette |
A palette name or a vector of colors. See tmaptools::palette_explorer() for the named palettes. Use a "-" as prefix to reverse the palette. |
style |
Method to process the color scale. Options available are "sd", "equal", "pretty", "quantile", "kmeans", "hclust", "bclust", "fisher", "jenks", and "log10_pretty". |
n |
Preferred number of classes. Default is 10. |
names |
Logical that determines whether the unit names are shown. |
borderLevel |
Adds contours of units on specified level - number from 1 to 6.
Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Generate quickly map for given NUTS level, using BDL data. Default level is 2.
Maps available for year: 2010-2020
Provide unit parent id to narrow the map for specific regions.
Generating lower (levels 5 and 6) level maps can take some time.
This function requires external map data "bdl.maps" loaded to global environment. You can get data here: Map download. Download data and double-click to load it to environment.
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 tmap map.
Examples
# generate_map(varId = "60559", year = "2017")
Get all aggregates
Description
Retrieve all aggregates with information.
Usage
get_aggregates(
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# get_aggregates()
Get all attributes
Description
Retrieve all attributes with information.
Usage
get_attributes(
sort = c("id", "-id", "Display", "-Display"),
lang = c("pl", "en"),
...
)
Arguments
sort |
A type of sorting, "id" (default), "-id", "Display", "-Display" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# get_attributes()
Get data by unit Id's from BDL API
Description
Retrieve data for given units from BDL with specified format.
Usage
get_data_by_unit(
unitId,
varId,
year = NULL,
type = c("code", "label"),
aggregateId = NULL,
lang = c("pl", "en"),
...
)
Arguments
unitId |
A single 12 character NUTS id code or vector of multiple unit id
codes. If multiple unit codes are used, some columns are not available.
Use |
varId |
A vector of variable Id's.Use |
year |
A vector of years. If |
type |
A type of variables returned, "code" (default), "label" |
aggregateId |
An aggregate id. Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Data to retrieve from
The
BDL Web Services can be filtered with arguments. To get JSON data from specified
directory with custom filters use get_request directly.
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_data_by_unit(unitId = "023200000000", varId = "3643")
# get_data_by_unit(unitId = "023200000000", varId = c("3643", "2137", "148190"),
# type = "label")
# Multi variable download
# get_data_by_unit(unitId = c("023200000000", "020800000000"),
# varId = c("3643", "2137", "148190"))
Get data by unit locality Id from BDL API
Description
Retrieve data for a given unit localities from BDL with specified format.
Usage
get_data_by_unit_locality(
unitId,
varId,
year = NULL,
type = c("code", "label"),
lang = c("pl", "en"),
...
)
Arguments
unitId |
A 12 character NUTS unit locality id with 7 characters locality individual id,
separated by dash or vector of multiple unit id codes. If multiple unit codes are used,
some columns are not available. Use |
varId |
A vector of variable Id's.Use |
year |
A vector of years. If |
type |
A type of variables returned, "code" (default), "label" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Data to retrieve from
The
BDL Web Services can be filtered with arguments. To get JSON data from specified
directory with custom filters use get_request directly.
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_data_by_unit_locality(unitId = "030210106062-0189782", varId = "415", type = "label")
# Multi variable download
# get_data_by_unit_locality(unitId = c("030210106062-0189782", "030210106062-0189753"),
# varId = "415")
Get data by variable Id from BDL API
Description
Retrieve data for a given variable for multiple units from BDL with specified format.
Usage
get_data_by_variable(
varId,
unitParentId = NULL,
unitLevel = NULL,
year = NULL,
aggregateId = NULL,
lang = c("pl", "en"),
...
)
Arguments
varId |
A single variable Id or vector of multiple variable id's. If multiple id's are used, some columns
are not available. Use |
unitParentId |
A 12 character NUTS id code of parent unit. Use |
unitLevel |
A number from 0 to 6, filters the returned unit by its level.
If |
year |
A vector of years. If |
aggregateId |
An aggregate id. Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Data to retrieve from
The
BDL Web Services can be filtered with arguments. To get JSON data from specified
directory with custom filters use get_request directly.
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_data_by_variable(varId = "3643", unitParentId = "030200000000")
# get_data_by_variable("420", year = "2000", unitLevel = 6)
# Multi variable download
# get_data_by_variable(varId =c("415","420"), unitParentId = "030210423000")
Get data by variable Id for localities from BDL API
Description
Retrieve data for a given variables for multiple unit localities from BDL with specified format.
Usage
get_data_by_variable_locality(
varId,
unitParentId,
year = NULL,
lang = c("pl", "en"),
...
)
Arguments
varId |
A single variable id or vector of multiple variable id's. If multiple id's are used, some columns
are not available.. Use |
unitParentId |
A 12 character NUTS id code of interested unit. Use |
year |
A vector of years. If |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Data to retrieve from
The
BDL Web Services can be filtered with arguments. To get JSON data from specified
directory with custom filters use get_request directly.
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_data_by_variable_locality(varId = "415", unitParentId = "011212006063")
# get_data_by_variable_locality("420", year = "2008", unitParentId = "070000000000")
# Multi variable download
# get_data_by_variable_locality(varId =c("415","430"), unitParentId = "011212006063")
Get all levels
Description
Retrieve all levels with information.
Usage
get_levels(sort = c("id", "-id", "name", "-name"), lang = c("pl", "en"), ...)
Arguments
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# get_levels()
Get panel data by unit and variable Id's from BDL API
Description
Retrieve data for given units from BDL with specified format.
Usage
get_panel_data(unitId, varId, year = NULL, ggplot = FALSE, ...)
Arguments
unitId |
A single 12 character NUTS id code or vector of multiple unit id
codes. If multiple unit codes are used, some columns are not available.
Use |
varId |
A single Id or vector of variable Id's.Use |
year |
A vector of years. If |
ggplot |
Output in a long format suitable for ggplot2. Allows to plot results directly with ggplot function. |
... |
Other arguments passed on to |
Details
Data to retrieve from
The
BDL Web Services can be filtered with arguments. To get JSON data from specified
directory with custom filters use get_request directly.
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_panel_data(unitId = "030210101000", varId = "60270")
# get_panel_data(unitId = "030210101000", varId = c("60270", "461668"))
# get_panel_data(unitId = c("030210101000", "030210105000", "030210106000"),
# varId = c("60270", "461668"), year = c(2013:2016))
# get_panel_data(unitId = c("030210101000", "030210105000", "030210106000"),
# varId = c("60270", "461668"), ggplot = TRUE)
Get JSON response from BDL API
Description
Retrieve data from BDL API in JSON format.
Usage
get_request(dir, id, filters = NULL, ...)
Arguments
dir |
A directory of the dataset. |
id |
A name for the dataset of interested. |
filters |
A named list of filters. Names of list objects are bdl
filter names and values are vectors with specified filter values. If |
... |
Other arguments passed on to |
Details
Data to retrieve from
The
BDL Web Services can be specified with filters. If no specific filters
required, it's recommended to use data query like get_data_by_unit_locality,
than to use get_request directly.
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 JSON raw data.
Examples
# get_request(dir = "data/By-Variable", id = "3643")
# get_request(dir = "data/By-Unit", id = "023200000000", filters = list(year = c("2000","2010"),
# var-Id" = c("2137","148190")))
# get_request(dir = "data/By-Variable", id = "3643", filters = list(year = c("2000","2010"),
# unit-Level" = 2, lang = "en"))
Get subject id codes.
Description
Retrieve all subjects id's or sub-subjects.
Usage
get_subjects(
parentId = "",
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
parentId |
A parent subject id code. If not specified returns all top level subjects.
Use |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
To get all top level subjects skip the parentId parameter or list
sub-subjects for given parent subject.
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_subjects()
# get_subjects("K3")
# get_subjects("G7")
Get unit locality codes.
Description
Retrieve unit locality codes.
Usage
get_unit_localities(
parentId,
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
parentId |
A 12 character NUTS id code of parent unit.
Use |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# get_unit_localities("030210106062")
Get unit NUTS codes.
Description
Retrieve all unit codes or sub to given unit,
Usage
get_units(
parentId = "",
level = NULL,
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
parentId |
A 12 character NUTS id code of parent unit.
Use |
level |
A number from 0 to 6, filters the returned unit by its level.
If |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
To get all units skip the parentId parameter. Warning! Downloading
all unit can take around 1 minute.
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_units(level = 2)
# get_units("010000000000")
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 |
level |
A number from 0 to 6, filters the returned unit by its level.
If |
year |
A vector of years. If |
sort |
A type of sorting, "id" (default), "-id", "subjectId", "-subjectId" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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")
Generate quick line plot
Description
Generate line plot for one unit/multiple variables or variable/multiple units
Usage
line_plot(
data_type = c("unit", "unit.locality", "variable", "variable.locality"),
unitId = NULL,
varId = NULL,
year = NULL,
aggregateId = NULL,
lang = NULL,
unitParentId = NULL,
unitLevel = NULL,
...
)
Arguments
data_type |
A type of data used for generating plot, "unit"(default), "unit.locality","variable","variable.locality" |
unitId |
A 12 character NUTS unit id or locality 12 character id with 7 characters locality individual id, separated by dash. |
varId |
A vector of variable Id's (data_type equal "unit" or "unit.locality)
or single variable (data_type equal "variable" or "variable.locality"). Use |
year |
A vector of years. If |
aggregateId |
An aggregate id. Use |
lang |
A language of returned data, "pl" (default), "en" |
unitParentId |
A 12 character NUTS id code of interested unit. (Used only with data_type equal "variable" or "variable.locality")
Use |
unitLevel |
A number from 0 to 6, filters the returned unit by its level. (Used only with data_type equal "variable")
If |
... |
Other arguments passed on to |
Details
Generate quickly 'ggplot2' plot, using BDL data.
Plot multiple variable values for one unit or one variable value for multiple units.
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 ggplot2 plot.
Examples
# line_plot(data_type = "unit", unitId = "000000000000", varId = c("415","420"))
Generate quick pie plot
Description
Generate pie plot for variable/multiple units
Usage
pie_plot(
data_type = c("variable", "variable.locality"),
varId,
year,
unitParentId = NULL,
unitLevel = NULL,
aggregateId = NULL,
label = T,
lang = c("pl", "en"),
...
)
Arguments
data_type |
A type of data used for generating plot, "variable"(default), "variable","variable.locality" |
varId |
A variable Id. Use |
year |
A single year. If |
unitParentId |
A 12 character NUTS id code of interested unit. Use |
unitLevel |
A number from 0 to 6, filters the returned unit by its level.
(Used only with data_type equal "variable")
If |
aggregateId |
An aggregate id. Use |
label |
Logical; if TRUE (default) adds labels. |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Generate quickly 'ggplot2' plot, using BDL data.
Pie plot one variable value for multiple units on single 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 ggplot2 plot.
Examples
# pie_plot(data_type ="variable" ,"1", "2018",unitParentId="042214300000", unitLevel = "6")
Generate quick scatter correlation plot
Description
Generate scatter correlation plot for 2 variables
Usage
scatter_2var_plot(
data_type = c("variable", "variable.locality"),
varId,
year = NULL,
unitParentId = NULL,
unitLevel = NULL,
aggregateId = NULL,
lang = c("pl", "en"),
...
)
Arguments
data_type |
A type of data used for generating plot, "variable"(default), "variable.locality" |
varId |
A vector of 2 variable Id's. Use |
year |
A vector of years. If |
unitParentId |
A 12 character NUTS id code of interested unit.
(Used only with data_type equal "variable" or "variable.locality")Use |
unitLevel |
A number from 0 to 6, filters the returned unit by its level.
(Used only with data_type equal "variable")
If |
aggregateId |
An aggregate id. Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
Details
Generate quickly 'ggplot2' scatter correlation plot, using BDL data.
Scatter plot 2 variables for given units with regression line, confidence interval and correlation coefficient.
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 ggplot2 plot.
Examples
# scatter_2var_plot(data_type = "variable" ,c("415", "60559"), unitLevel = "2")
Search for subject codes
Description
Search for given phrase in subject names
Usage
search_subjects(
name,
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
name |
A phrase to search. |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# search_subjects("samochody")
# search_subjects("car", lang = "en")
Search for unit localities
Description
Search for a given phrase in unit locality names.
Usage
search_unit_localities(
name,
year = NULL,
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
name |
A phrase to search. |
year |
A vector of years. If |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# search_unit_localities("wro")
Search for units
Description
Search for a given phrase in unit names.
Usage
search_units(
name,
level = NULL,
year = NULL,
kind = NULL,
sort = c("id", "-id", "name", "-name"),
lang = c("pl", "en"),
...
)
Arguments
name |
A phrase to search. |
level |
A number from 0 to 6, filters the returned unit by its level.
If |
year |
A vector of years. If |
kind |
A type of unit. More info at: https://bdl.stat.gov.pl/BDL/metadane/teryt/rodzaj |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# search_units("wro")
# search_units("pol", type = "5")
Search for variable codes
Description
Search for given phrase in variable names
Usage
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 |
level |
A number from 0 to 6, filters the returned unit by its level.
If |
year |
A vector of years. If |
sort |
A type of sorting, "id" (default), "-id", "name", "-name" |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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
# search_variables("samochody")
# search_variables("cars", lang = "en")
Information about subject
Description
Retrieve information about subject
Usage
subject_info(subjectId, lang = c("pl", "en"), ...)
Arguments
subjectId |
A subject id code. If not specified returns all top level subjects.
Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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 named list.
Examples
# subject_info("G7")
Summarize bdl data frame
Description
Prints brief summary with basic statistical functions like mean, standard deviation, variance, min and max for bdl data frame.
Usage
## S3 method for class 'bdl'
summary(object, ...)
Arguments
object |
bdl data frame to summarise |
... |
other arguments ignored (for compatibility with generic) |
Examples
# df <- get_data_by_variable(varId = "3643")
# summary(df)
Information about unit
Description
Retrieve information about unit
Usage
unit_info(unitId, lang = c("pl", "en"), ...)
Arguments
unitId |
A 12 character NUTS id code of interested unit. Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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 named list.
Examples
# unit_info("030210106062")
Information about unit locality
Description
Retrieve information about unit locality
Usage
unit_locality_info(unitId, lang = c("pl", "en"), ...)
Arguments
unitId |
A 12 character NUTS id with 7 characters locality individual id, separated by dash.
Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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 named list.
Examples
# unit_locality_info("030210106062-0189782")
Information about variable
Description
Retrieve information about variable.
Usage
variable_info(varId, lang = c("pl", "en"), ...)
Arguments
varId |
A vector of variable Id's.Use |
lang |
A language of returned data, "pl" (default), "en" |
... |
Other arguments passed on to |
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 named list.
Examples
# variable_info("420")