# RCzechia

This project downloads a set of shapefiles relevant to the Czech
Republic. It was inspired by the popular
[`tigris`](https://github.com/walkerke/tigris) package for US datasets.

![Kraje České
republiky](https://github.com/jlacko/RCzechia/blob/master/data-raw/kraje-lo-res.png?raw=true)

For examples of RCzechia in action please see the package vignette:

- [Visualizing Czech
  Population](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#visualizing-czech-population)
- [Geocoding Locations & Drawing them on a
  Map](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#geocoding-locations-drawing-them-on-a-map)
- [Distance Between Prague and
  Brno](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#distance-between-prague-and-brno)
- [Geographical Center of the City of
  Brno](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#geographical-center-of-the-city-of-brno)
- [Interactive
  Map](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#interactive-map)
- [KFME Grid Cells - faunistické
  čtverce](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#kfme-grid-cells)
- [Terrain of the Czech
  Republic](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#terrain-of-the-czech-republic)
- [Senate elections of
  2020](https://CRAN.R-project.org/package=RCzechia/vignettes/vignette.html#senate-elections-of-2020)

The administrative area polygons are based on the [RÚIAN
register](https://cs.wikipedia.org/wiki/Registr_%C3%BAzemn%C3%AD_identifikace,_adres_a_nemovitost%C3%AD);
the natural objects were based originally on [ArcČR
500](https://www.arcdata.cz/cs-cz/produkty/data/arccr#text-3f16b51360)
by ARCDATA and later moved to
[Data200](https://geoportal.cuzk.cz/Default.aspx?mode=TextMeta&side=mapy_data200&text=dSady_mapyData200)
by ČÚZK.

The shapefiles are by necessity larger than the limits of a CRAN package
size allow. The data are therefore stored remotely (on Amazon Cloud /
AWS S3) and downloaded as required. As consequence a working internet
connection is required to fully use the package.

For the most commonly used shapes (*republika*, *kraje* and *okresy*) an
optional low resolution version is also included. To access it specify
the value of `resolution` parameter as `"low"` (default is `"high"`).

Access to the external files is logged, from time to time I check the
logs (mainly to better understand my bandwidth charges).

### A note to Czech users

Tohle je “oficiální”, a tedy anglické, readme. Českou verzi naleznete na
<http://www.jla-data.net/cze/package-rczechia/>

### Installation

The package is on CRAN (as of March 2018) so to get a stable version
simply run:

``` r

install.packages("RCzechia")
```

You can also get the latest development version by running
`remotes::install_github("jlacko/RCzechia")`. The main branch should be
always reasonably stable, but I do not suggest cloning of development
branches unless you know what you are doing - these are where the raw
action is happening, red in tooth and claw.

### The following spatial objects are included:

administrative:

- **republika**: borders of the Czech Republic as a polygon
- **kraje**: 14 regions of the Czech Republic & Prague  
- **okresy**: 76 districts (LAU1 areas) of the Czech Republic + Prague
  (legally not *a district* but *the capital*)  
- **orp_polygony** 205 municipalities with extended powers (in Czech:
  obce s rozšířenou působností) + Prague (legally not *a city* but *the
  capital*)  
- **obce_polygony**: 6.258 municipalities of the Czech Republic  
- **obce_body** the same as obce_polygony, but centroids instead of
  polygons  
- **casti**: primarily 57 city parts of Prague, but also of other cities
  with defined parts (Brno, Ostrava and other)
- **katastry**: 13.076 cadastral areas (katastrální území) of the Czech
  Republic
- **senat_obvody**: 81 senate districts (volební obvody senátu)
- **volebni_okrsky**: 14.733 general election districts (volební okrsky)
- **zip_codes**: 2.671 ZIP code areas (poštovní směrovací čísla / PSČ)
- **historie**: historical administrative areas + census data, notably
  including data on German speaking residents before the second world
  war

natural:

- **reky**: streams and rivers
- **plochy**: stillwaters (lakes and ponds).
- **silnice**: roads (highways, speedways etc.)
- **zeleznice**: railroads
- **chr_uzemi**: protected natural areas (chráněná území)
- **lesy**: woodland areas (more than 30 ha in area)
- **KFME_grid**: KFME grid cells (faunistické čtverce)
- **vyskopis**: terrain of the Czech republic as a {terra} package
  raster object
- **geomorfo**: geomorphological division of the Czech Republic

All objects are implemented as functions returning data frames, so must
be followed by brackets (i.e. `hranice <- republika()`).

### In addition a number of utility functions is provided:

- **geocode**: interfaces to geocoding API of
  [ČÚZK](https://cuzk.gov.cz/en).
- **revgeo**: interfaces to reverse geocoding API of
  [ČÚZK](https://cuzk.gov.cz/en).

## Call for Action

The project is actively maintained, and ideas & suggestions to improve
the package are greatly welcome. Should you feel more at ease with old
fashioned email than the GitHub ticketing system - do drop me a line.

But raising an issue is preferable, as I am human and I forget; GitHub
does not suffer from such a failing, and will keep on reminding me till
the sun and moon are darkened, and the stars no longer shine.

More detailed information can be found in the
[CONTRIBUTING](https://github.com/jlacko/RCzechia/blob/master/CONTRIBUTING.md)
document.

## Code of Conduct

Please note that the RCzechia project is released with a [Contributor
Code of
Conduct](https://github.com/jlacko/RCzechia/blob/master/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.

# Package index

## All functions

- [`KFME_grid()`](https://rczechia.jla-data.net/reference/KFME_grid.md)
  : KFME grid cells (faunistické čtverce) of the Czech Republic
- [`RCzechia`](https://rczechia.jla-data.net/reference/RCzechia-package.md)
  [`RCzechia-package`](https://rczechia.jla-data.net/reference/RCzechia-package.md)
  : RCzechia: Spatial Objects of the Czech Republic
- [`casti()`](https://rczechia.jla-data.net/reference/casti.md) : City
  Districts
- [`chr_uzemi()`](https://rczechia.jla-data.net/reference/chr_uzemi.md)
  : Protected Natural Areas
- [`geocode()`](https://rczechia.jla-data.net/reference/geocode.md) :
  Geocode a Czech Address
- [`geomorfo()`](https://rczechia.jla-data.net/reference/geomorfo.md) :
  Geomorphological division of the Czech Republic
- [`historie()`](https://rczechia.jla-data.net/reference/historie.md) :
  Historical censuses of the Czech Republic
- [`katastry()`](https://rczechia.jla-data.net/reference/katastry.md) :
  Cadastral Areas
- [`kraje()`](https://rczechia.jla-data.net/reference/kraje.md) :
  Regions (kraje) of the Czech Republic
- [`lesy()`](https://rczechia.jla-data.net/reference/lesy.md) : Woodland
  Areas
- [`obce_body()`](https://rczechia.jla-data.net/reference/obce_body.md)
  : Municipalities / communes (obce) as centerpoints
- [`obce_polygony()`](https://rczechia.jla-data.net/reference/obce_polygony.md)
  : Municipalities / communes (obce) as polygons
- [`okresy()`](https://rczechia.jla-data.net/reference/okresy.md) :
  Districts (okresy)
- [`orp_polygony()`](https://rczechia.jla-data.net/reference/orp_polygony.md)
  : Obce s rozsirenou pusobnosti
- [`plochy()`](https://rczechia.jla-data.net/reference/plochy.md) :
  Water Bodies
- [`reky()`](https://rczechia.jla-data.net/reference/reky.md) : Rivers
- [`republika()`](https://rczechia.jla-data.net/reference/republika.md)
  : Republika
- [`revgeo()`](https://rczechia.jla-data.net/reference/revgeo.md) :
  Reversely Geocode a Czech Address
- [`senat_obvody()`](https://rczechia.jla-data.net/reference/senat_obvody.md)
  : Senate Districts (Volební obvod pro volby do Senátu) of the Czech
  Republic
- [`set_home()`](https://rczechia.jla-data.net/reference/set_home.md) :
  Set the local cache directory
- [`silnice()`](https://rczechia.jla-data.net/reference/silnice.md) :
  Road Network
- [`unset_home()`](https://rczechia.jla-data.net/reference/unset_home.md)
  : Unset the local cache directory
- [`volebni_okrsky()`](https://rczechia.jla-data.net/reference/volebni_okrsky.md)
  : Election Districts (Volební okrsky) of the Czech Republic
- [`vyskopis()`](https://rczechia.jla-data.net/reference/vyskopis.md) :
  Vyskopis
- [`zeleznice()`](https://rczechia.jla-data.net/reference/zeleznice.md)
  : Railroad Network
- [`zip_codes()`](https://rczechia.jla-data.net/reference/zip_codes.md)
  : ZIP Codes of the Czech Republic

# Articles

### All vignettes

- [Solving Real World Issues With
  RCzechia](https://rczechia.jla-data.net/articles/vignette.md):