SmarterPoland (version 1.5)

Bank Danych Lokalnych: API to Bank Danych Lokalnych [GUS]

Description

Access to the GUS Bank Danych Lokalnych with the use of API developed by MojePanstwo.

Download and parse data from Bank Danych Lokalnych with the use of API developed by MojePanstwo.

Usage

getBDLtree(debug = 0, raw = FALSE)
getBDLsearch(query = "", debug = 0, raw = FALSE)
getBDLseries(metric_id = "", slice = NULL, time_range = NULL,
            wojewodztwo_id = NULL, powiat_id = NULL, gmina_id = NULL,
            meta = NULL, debug = 0, raw = FALSE)

Arguments

debug

Level of debug info. 0 for no debug, 1 or 2 for info about processed groups.

raw

If raw = FALSE the the resulting JSON is returned without any transformation. For raw = TRUE results are transformed into a data.frame.

query

A query for DBL search.

metric_id

Metric id, if unknown then look for it in DBL tree or DBL search.

slice

A table with id dimensions, with format [1,34,*]. Use '*' to choose all dimensions (or use empty string).

time_range

Year or range (like 2000:2010), empty means - full range.

wojewodztwo_id

Voievodship id or '*' for all.

powiat_id

County id of '*' for all.

gmina_id

Subcounty id or '*' for all.

meta

Should meta data be returned?

Value

• The function getBDLtree() returns a data frame with identifiers of resources in Bank Danych Lokalnych.

References

The API of Bank Danych Lokalnych developed by MojePanstwo is described as http://mojepanstwo.pl/api/!/bdl/!/bdl/!/bdl/series

Examples

# the data is downloaded and parsed from Internet
 # not that this dataset is precalcualted in the package
 BDLtree <- getBDLtree(2)
 head(BDLtree)

 DBLtransport <- getBDLsearch("transport")
 head(DBLtransport)
 
 BDLseries <- getBDLseries(metric_id = 1)
 head(BDLseries)