BankDanychLokalnych: API to Bank Danych Lokalnych [GUS]

In SmarterPoland: Tools for Accessing Various Datasets Developed by the Foundation SmarterPoland.pl

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(raw = FALSE, debug = 0)
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)
getMPgminy(debug = 0)
getMPpowiaty(debug = 0)
getMPwojewodztwa(debug = 0)

Arguments

debug	Level of debug info. 0 for no debug, 1 or 2 for info about processed groups.
raw	If raw = TRUE the resulting JSON is returned without any transformation. For raw = FALSE 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 an 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. It's internal ID. Use getMPpowiaty() to get names and other information.
gmina_id	Subcounty id or '*' for all. It's internal ID. Use getMPgminy() to get TERYT codes.
meta	Should meta data be returned?

Value

The function getMPgminy() returns a data frame with identifiers id/TERYT for each subcounty. The function getMPpowiaty() returns a data frame with identifiers id for each county.

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

Author(s)

Przemyslaw Biecek

References

The API of Bank Danych Lokalnych developed by MojePanstwo is described as https://mojepanstwo.pl/api/dane/get_dane_dataset

Examples

## Not run: 
 # the data is downloaded and parsed from Internet
 # not that this dataset is pre-calculated in the package
 BDLtree <- getBDLtree(2)
 head(BDLtree)

 DBLtransport <- getBDLsearch("transport")
 head(DBLtransport)

 BDLseries <- getBDLseries(metric_id = 1)
 head(BDLseries)

 gminy <- getMPgminy()
 head(gminy)

 powiaty <- getMPpowiaty()
 head(powiaty)

## End(Not run)

SmarterPoland documentation built on Aug. 21, 2023, 1:06 a.m.