rgugik

https://kadyb.github.io/rgugik/
Admin
rgugik is an R package for downloading open geospatial data from Polish government resources...
Tokens:68,876
Snippets:358
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Examples

Source: https://kadyb.github.io/rgugik/reference/emuia_download.html

Examples of how to use the emuia_download function.

```R
if (FALSE) { # \dontrun{
emuia_download(commune = "Kotla") # 38 KB
emuia_download(TERYT = c("0203042", "2412032")) # 75 KB
} # }
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/models3D_download.html

Examples of how to use the models3D_download function.

```R
if (FALSE) { # \dontrun{
models3D_download(TERYT = c("2476", "2264")) # 3.6 MB
models3D_download(county = "sejneński", LOD = "LOD2") # 7.0 MB
} # } 
```

--------------------------------

### Installation

Source: https://kadyb.github.io/rgugik/index.html

Install the development version from GitHub.

```r
# install.packages("remotes")
remotes::install_github("kadyb/rgugik")
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/borders_get.html

Examples of how to use the borders_get function to retrieve boundaries for different administrative levels.

```R
if (FALSE) { # \dontrun{
voivodeship_geom = borders_get(voivodeship = "lubuskie") # 494 KB
county_geom = borders_get(county = "Sopot") # 18 KB
commune_geom = borders_get(commune = c("Hel", "Krynica Morska")) # 11 KB
poland_geom = borders_get() # 1124.3 KB
} # } 
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/pointDTM100_download.html

Examples of how to use the pointDTM100_download function with different inputs.

```R
if (FALSE) { # \dontrun{
pointDTM100_download(c("opolskie", "świętokrzyskie")) # 8.5 MB
pointDTM100_download(c("Opole", "Swietokrzyskie")) # 8.5 MB
pointDTM100_download(c("16", "26")) # 8.5 MB
} # } 
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/geodb_download.html

Examples of how to use the geodb_download function with different inputs.

```R
if (FALSE) { # \dontrun{
geodb_download(c("opolskie", "lubuskie")) # 12.7 MB
geodb_download(c("Opole", "Lubusz")) # 12.7 MB
geodb_download(c("16", "08")) # 12.7 MB
} # }
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/tile_download.html

Example code demonstrating how to use the tile_download function for both ortho and DEM requests.

```R
if (FALSE) { # \dontrun{
library(sf)
options(timeout = 600)
polygon_path = system.file("datasets/search_area.gpkg", package = "rgugik")
polygon = read_sf(polygon_path)

req_df = ortho_request(polygon)
tile_download(req_df[1, ]) # download the first image only

req_df = DEM_request(polygon)
tile_download(req_df[1, ]) # download the first DEM only
} # } 

```

--------------------------------

### Example of using minmaxDTM_get

Source: https://kadyb.github.io/rgugik/reference/minmaxDTM_get.html

Demonstrates how to load an SF object and use it with the minmaxDTM_get function to get elevation data.

```R
if (FALSE) { # \dontrun{
library(sf)
polygon_path = system.file("datasets/search_area.gpkg", package = "rgugik")
polygon = read_sf(polygon_path)
minmax = minmaxDTM_get(polygon)
} # }
```

--------------------------------

### Examples of geocodePL_get

Source: https://kadyb.github.io/rgugik/reference/geocodePL_get.html

Provides examples of how to use geocodePL_get for different types of location queries.

```R
if (FALSE) { # \dontrun{
geocodePL_get(address = "Marki") # place
geocodePL_get(address = "Marki, Andersa") # place and street
geocodePL_get(address = "Marki, Andersa 1") # place, street and house number
geocodePL_get(address = "Królewskie Brzeziny 13") # place and house number

geocodePL_get(road = "632") # road number
geocodePL_get(road = "632 55") # road number and mileage

geocodePL_get(rail_crossing = "001 018 478")

geocodePL_get(geoname = "Las Mierzei") # physiographic object
} # } 
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/egib_download.html

Example usage of the egib_download function to download buildings and parcels layers.

```R
if (FALSE) { # \dontrun{
egib_download(TERYT = c("2476", "2264"), layer = "buildings", outdir = ".") # 2.2 + 2.6 MB
parcels = egib_download(county = "Świętochłowice", layer = "parcels", outdir = NULL) # 3.9 MB
} # } 
```

--------------------------------

### egib_layers Output Example

Source: https://kadyb.github.io/rgugik/reference/egib_layers.html

An example output from the egib_layers command, listing administrative regions and their TERYT codes.

```shell
egib_layers
#>                        NAME TERYT
#> 1             bolesławiecki  0201
#> 2            dzierżoniowski  0202
#> 3                 głogowski  0203
#> 4                  górowski  0204
#> 5                  jaworski  0205
#> 6             jeleniogórski  0206
#> 7            kamiennogórski  0207
#> 8                   kłodzki  0208
#> 9                  legnicki  0209
#> 10                 lubański  0210
#> 11                 lubiński  0211
#> 12                 lwówecki  0212
#> 13                  milicki  0213
#> 14                oleśnicki  0214
#> 15                  oławski  0215
#> 16               polkowicki  0216
#> 17              strzeliński  0217
#> 18                  średzki  0218
#> 19                świdnicki  0219
#> 20               trzebnicki  0220
#> 21               wałbrzyski  0221
#> 22                 wołowski  0222
#> 23               wrocławski  0223
#> 24               ząbkowicki  0224
#> 25              zgorzelecki  0225
#> 26              złotoryjski  0226
#> 27             Jelenia Góra  0261
#> 28                  Legnica  0262
#> 29                  Wrocław  0264
#> 30                Wałbrzych  0265
#> 31           aleksandrowski  0401
#> 32                brodnicki  0402
#> 33                 bydgoski  0403
#> 34               chełmiński  0404
#> 35      golubsko-dobrzyński  0405
#> 36              grudziądzki  0406
#> 37            inowrocławski  0407
#> 38                lipnowski  0408
#> 39               mogileński  0409
#> 40                nakielski  0410
#> 41             radziejowski  0411
#> 42                 rypiński  0412
#> 43               sępoleński  0413
#> 44                  świecki  0414
#> 45                 toruński  0415
#> 46                tucholski  0416
#> 47                wąbrzeski  0417
#> 48               włocławski  0418
#> 49                  żniński  0419
#> 50                Bydgoszcz  0461
#> 51                Grudziądz  0462
#> 52                    Toruń  0463
#> 53                Włocławek  0464
#> 54                  bialski  0601
#> 55              biłgorajski  0602
#> 56                 chełmski  0603
#> 57            hrubieszowski  0604
#> 58                 janowski  0605
#> 59            krasnostawski  0606
#> 60                kraśnicki  0607
#> 61              lubartowski  0608
#> 62                 lubelski  0609
#> 63                łęczyński  0610
#> 64                 łukowski  0611
#> 65                  opolski  0612
#> 66               parczewski  0613
#> 67                 puławski  0614
#> 68                radzyński  0615
#> 69                    rycki  0616
#> 70                świdnicki  0617
#> 71              tomaszowski  0618
#> 72                włodawski  0619
#> 73                 zamojski  0620
#> 74           Biała Podlaska  0661
#> 75                    Chełm  0662
#> 76                   Lublin  0663
#> 77                   Zamość  0664
#> 78                gorzowski  0801
#> 79              krośnieński  0802
#> 80             międzyrzecki  0803
#> 81               nowosolski  0804
#> 82                 słubicki  0805
#> 83   strzelecko-drezdenecki  0806
#> 84               sulęciński  0807
#> 85            świebodziński  0808
#> 86            zielonogórski  0809
#> 87                 żagański  0810
#> 88                   żarski  0811
#> 89                wschowski  0812
#> 90      Gorzów Wielkopolski  0861
#> 91             Zielona Góra  0862
#> 92             bełchatowski  1001
#> 93                kutnowski  1002
#> 94                    łaski  1003
#> 95                 łęczycki  1004
#> 96                  łowicki  1005
#> 97          łódzki wschodni  1006
#> 98               opoczyński  1007
#> 99               pabianicki  1008
#> 100             pajęczański  1009
#> 101             piotrkowski  1010
#> 102              poddębicki  1011
#> 103          radomszczański  1012
#> 104                  rawski  1013
#> 105               sieradzki  1014
#> 106           skierniewicki  1015
#> 107             tomaszowski  1016
#> 108               wieluński  1017
#> 109            wieruszowski  1018
#> 110           zduńskowolski  1019
#> 111                zgierski  1020
#> 112              brzeziński  1021
#> 113                    Łódź  1061
#> 114    Piotrków Trybunalski  1062
#> 115            Skierniewice  1063
#> 116               bocheński  1201
#> 117                 brzeski  1202
#> 118             chrzanowski  1203
#> 119               dąbrowski  1204
#> 120                gorlicki  1205
#> 121               krakowski  1206
#> 122              limanowski  1207
#> 123              miechowski  1208
#> 124              myślenicki  1209
#> 125             nowosądecki  1210
#> 126              nowotarski  1211
#> 127                 olkuski  1212
#> 128             oświęcimski  1213
#> 129             proszowicki  1214
#> 130                   suski  1215
#> 131               tarnowski  1216
#> 132              tatrzański  1217
#> 133               wadowicki  1218
```

--------------------------------

### Installation

Source: https://kadyb.github.io/rgugik/index.html

Install the released version from CRAN.

```r
install.packages("rgugik")
```

--------------------------------

### Example: Download administrative units

Source: https://kadyb.github.io/rgugik/reference/borders_download.html

An example showing how to download the 'administrative units' data type.

```R
if (FALSE) { # \dontrun{
borders_download("administrative units") # 366 MB
} # }
```

--------------------------------

### Examples

Source: https://kadyb.github.io/rgugik/reference/voivodeship_names.html

Example output of the `voivodeship_names` data frame, showing Polish and English names, and TERC identifiers.

```r
voivodeship_names
#>                NAME_PL             NAME_EN TERC
#> 1         dolnośląskie       Lower Silesia   02
#> 2   kujawsko-pomorskie Kuyavian-Pomeranian   04
#> 3            lubelskie              Lublin   06
#> 4             lubuskie              Lubusz   08
#> 5              łódzkie                Lodz   10
#> 6          małopolskie       Lesser Poland   12
#> 7          mazowieckie            Mazovian   14
#> 8             opolskie               Opole   16
#> 9         podkarpackie       Subcarpathian   18
#> 10           podlaskie           Podlaskie   20
#> 11           pomorskie          Pomeranian   22
#> 12             śląskie            Silesian   24
#> 13      świętokrzyskie      Swietokrzyskie   26
#> 14 warmińsko-mazurskie    Warmian-Masurian   28
#> 15       wielkopolskie      Greater Poland   30
#> 16  zachodniopomorskie     West Pomeranian   32
```

--------------------------------

### Usage

Source: https://kadyb.github.io/rgugik/reference/geodb_download.html

The usage example for the geodb_download function.

```R
geodb_download(voivodeships, outdir = ".", unzip = TRUE, ...)
```

--------------------------------

### Example: Downloading place names in SHP format

Source: https://kadyb.github.io/rgugik/reference/geonames_download.html

An example of how to download geographical names of places in the SHP format.

```R
geonames_download(type = "place", format = "SHP") # 18.2 MB
```

--------------------------------

### County Data Example

Source: https://kadyb.github.io/rgugik/reference/county_names.html

This snippet shows a sample of county data, including an index, name, code, and a boolean flag.

```text
345            wieruszowski  1018 FALSE
346               Włocławek  0464  TRUE
347              włocławski  0418  TRUE
348               włodawski  0619  TRUE
349            włoszczowski  2613  TRUE
350            wodzisławski  2415  TRUE
351             wolsztyński  3029 FALSE
352              wołomiński  1434  TRUE
353                wołowski  0222 FALSE
354                 Wrocław  0264 FALSE
355              wrocławski  0223 FALSE
356              wrzesiński  3030 FALSE
357               wschowski  0812 FALSE
358        wysokomazowiecki  2013  TRUE
359              wyszkowski  1435  TRUE
360                  Zabrze  2478  TRUE
361              zambrowski  2014  TRUE
362                zamojski  0620  TRUE
363                  Zamość  0664  TRUE
364           zawierciański  2416  TRUE
365              ząbkowicki  0224 FALSE
366           zduńskowolski  1019 FALSE
367                zgierski  1020 FALSE
368             zgorzelecki  0225 FALSE
369            Zielona Góra  0862 FALSE
370           zielonogórski  0809 FALSE
371             złotoryjski  0226 FALSE
372               złotowski  3031 FALSE
373               zwoleński  1436  TRUE
374                żagański  0810 FALSE
375                  żarski  0811 FALSE
376                 żniński  0419  TRUE
377                    Żory  2479  TRUE
378              żuromiński  1437  TRUE
379             żyrardowski  1438  TRUE
380                żywiecki  2417  TRUE
```

--------------------------------

### commune_names Output

Source: https://kadyb.github.io/rgugik/reference/commune_names.html

Example output of the commune_names command, listing commune names and their TERYT codes.

```text
commune_names
#>                         NAME   TERYT
#> 1                Bolesławiec 0201011
#> 2                Bolesławiec 0201022
#> 3                   Gromadka 0201032
#> 4               Nowogrodziec 0201043
#> 5                 Osiecznica 0201052
#> 6        Warta Bolesławiecka 0201062
#> 7                    Bielawa 0202011
#> 8                Dzierżoniów 0202021
#> 9                   Pieszyce 0202033
#> 10              Piława Górna 0202041
#> 11               Dzierżoniów 0202052
#> 12                Łagiewniki 0202062
#> 13                   Niemcza 0202073
#> 14                    Głogów 0203011
#> 15                    Głogów 0203022
#> 16                Jerzmanowa 0203032
#> 17                     Kotla 0203042
#> 18                    Pęcław 0203052
#> 19                  Żukowice 0203062
#> 20                      Góra 0204013
#> 21                  Jemielno 0204022
#> 22                  Niechlów 0204032
#> 23                    Wąsosz 0204043
#> 24                     Jawor 0205011
#> 25                    Bolków 0205023
#> 26                   Męcinka 0205032
#> 27                 Mściwojów 0205042
#> 28                 Paszowice 0205052
#> 29           Wądroże Wielkie 0205062
#> 30                   Karpacz 0206011
#> 31                    Kowary 0206021
#> 32                Piechowice 0206031
#> 33          Szklarska Poręba 0206041
#> 34          Janowice Wielkie 0206052
#> 35             Jeżów Sudecki 0206062
#> 36               Mysłakowice 0206072
#> 37                 Podgórzyn 0206082
#> 38           Stara Kamienica 0206092
#> 39             Kamienna Góra 0207011
#> 40             Kamienna Góra 0207022
#> 41                   Lubawka 0207033
#> 42                 Marciszów 0207042
#> 43            Duszniki-Zdrój 0208011
#> 44                   Kłodzko 0208021
#> 45              Kudowa-Zdrój 0208031
#> 46                 Nowa Ruda 0208041
#> 47            Polanica-Zdrój 0208051
#> 48         Bystrzyca Kłodzka 0208063
#> 49                   Kłodzko 0208072
#> 50               Lądek-Zdrój 0208083
#> 51             Lewin Kłodzki 0208092
#> 52               Międzylesie 0208103
#> 53                 Nowa Ruda 0208112
#> 54                    Radków 0208123
#> 55           Stronie Śląskie 0208133
#> 56                  Szczytna 0208143
#> 57                   Chojnów 0209011
#> 58                   Chojnów 0209022
#> 59                Krotoszyce 0209032
#> 60                    Kunice 0209042
#> 61            Legnickie Pole 0209052
#> 62                 Miłkowice 0209062
#> 63                Prochowice 0209073
#> 64                      Ruja 0209082
#> 65                     Lubań 0210011
#> 66           Świeradów-Zdrój 0210021
#> 67                     Leśna 0210033
#> 68                     Lubań 0210042
#> 69                   Olszyna 0210053
#> 70                Platerówka 0210062
#> 71               Siekierczyn 0210072
#> 72                     Lubin 0211011
#> 73                     Lubin 0211022
#> 74                     Rudna 0211032
#> 75                   Ścinawa 0211043
#> 76             Gryfów Śląski 0212013
#> 77                 Lubomierz 0212023
#> 78             Lwówek Śląski 0212033
#> 79                     Mirsk 0212043
#> 80                      Wleń 0212053
#> 81                  Cieszków 0213012
#> 82                  Krośnice 0213022
#> 83                    Milicz 0213033
#> 84                  Oleśnica 0214011
#> 85                  Bierutów 0214023
#> 86                Dobroszyce 0214032
#> 87            Dziadowa Kłoda 0214042
#> 88                Międzybórz 0214053
#> 89                  Oleśnica 0214062
#> 90                     Syców 0214073
#> 91                Twardogóra 0214083
#> 92                     Oława 0215011
#> 93                  Domaniów 0215022
#> 94           Jelcz-Laskowice 0215033
#> 95                     Oława 0215042
#> 96                 Chocianów 0216013
#> 97                 Gaworzyce 0216022
#> 98                 Grębocice 0216032
#> 99                 Polkowice 0216043
#> 100                 Przemków 0216053
#> 101                Radwanice 0216062
#> 102                    Borów 0217012
#> 103             Kondratowice 0217022
#> 104                Przeworno 0217032
#> 105                 Strzelin 0217043
#> 106                   Wiązów 0217053
#> 107               Kostomłoty 0218012
#> 108                 Malczyce 0218022
#> 109                 Miękinia 0218033
#> 110             Środa Śląska 0218043
#> 111                   Udanin 0218052
#> 112                 Świdnica 0219011
#> 113              Świebodzice 0219021
#> 114               Dobromierz 0219032
#> 115         Jaworzyna Śląska 0219043
#> 116              Marcinowice 0219052
#> 117                 Strzegom 0219063
#> 118                 Świdnica 0219072
#> 119                    Żarów 0219083
#> 120         Oborniki Śląskie 0220013
#> 121                  Prusice 0220023
#> 122                Trzebnica 0220033
#> 123             Wisznia Mała 0220042
```

--------------------------------

### Example of ortho_request

Source: https://kadyb.github.io/rgugik/reference/ortho_request.html

Demonstrates how to use ortho_request with an sf object and filter the results.

```R
if (FALSE) { # \dontrun{
library(sf)
polygon_path = system.file("datasets/search_area.gpkg", package = "rgugik")
polygon = read_sf(polygon_path)
req_df = ortho_request(polygon)

# simple filtering by attributes
req_df = req_df[req_df$composition == "CIR", ]
req_df = req_df[req_df$resolution <= 0.25 & req_df$year >= 2016, ]
} # } 
```

--------------------------------

### Administrative boundaries

Source: https://kadyb.github.io/rgugik/index.html

Example of getting administrative boundaries for a voivodeship.

```r
library(rgugik)
library(sf)

# get counties from opolskie voivodeship (TERYT 16)
counties = county_names
counties = counties[substr(counties$TERYT, 1, 2) == "16", "TERYT"]
counties_geom = borders_get(TERYT = counties)
plot(st_geometry(counties_geom), main = "Opolskie")
```

--------------------------------

### Example of using DEM_request function

Source: https://kadyb.github.io/rgugik/reference/DEM_request.html

Demonstrates how to use the DEM_request function to get digital elevation model data, including filtering by year, product, and format.

```R
if (FALSE) { # \dontrun{
library(sf)
polygon_path = system.file("datasets/search_area.gpkg", package = "rgugik")
polygon = read_sf(polygon_path)
req_df = DEM_request(polygon)

# simple filtering by attributes
req_df = req_df[req_df$year > 2018, ]
req_df = req_df[req_df$product == "PointCloud" & req_df$format == "LAS", ]
} # } 
```

--------------------------------

### Attach packages

Source: https://kadyb.github.io/rgugik/articles/topodb.html

Loads the necessary sf and rgugik packages for spatial data analysis.

```R
# attach packages
library(sf)
library(rgugik)
```

--------------------------------

### Cloning the repository

Source: https://kadyb.github.io/rgugik/CONTRIBUTING.html

Steps to fork and clone the rgugik repository to your local machine.

```bash
git clone https://github.com/kadyb/rgugik.git
```

--------------------------------

### Example usage of pointDTM_get function

Source: https://kadyb.github.io/rgugik/reference/pointDTM_get.html

An example demonstrating how to load an sf polygon and use the pointDTM_get function to retrieve DTM data.

```R
if (FALSE) { # \dontrun{
library(sf)
polygon_path = system.file("datasets/search_area.gpkg", package = "rgugik")
polygon = read_sf(polygon_path)
DTM = pointDTM_get(polygon, distance = 2)
} # } 
```

--------------------------------

### Usage

Source: https://kadyb.github.io/rgugik/reference/pointDTM100_download.html

The usage of the pointDTM100_download function.

```R
pointDTM100_download(voivodeships, outdir = ".", unzip = TRUE, ...)
```

--------------------------------

### Examples of parcel_get function

Source: https://kadyb.github.io/rgugik/reference/parcel_get.html

Provides examples of how to use the parcel_get function to retrieve parcel geometry using a TERYT ID or coordinates.

```R
if (FALSE) { # \dontrun{
parcel = parcel_get(TERYT = "141201_1.0001.6509")
parcel = parcel_get(X = 313380.5, Y = 460166.4)
} # }
```
Tokens:
Raw