pragr: Tools for visualising Prague data

#' Prague RUIAN code
#'
#' Prague RUIAN code
#'
#' @format character vector of length 1
#' \describe{
#'   Prague RUIAN code
#' }
#' @family Codes and metadata
"prg_kod"

#' Prague ICO code
#'
#' Prague ICO code
#'
#' @format character vector of length 1
#' \describe{
#'   Prague ICO code
#' }
#' @family Codes and metadata
"prg_ico"

#' Prague NUTS2 code
#'
#' Prague NUTS2 code
#'
#' @format character vector of length 1
#' \describe{
#'   Prague NUTS2 code
#' }
#' @family Codes and metadata
"prg_nuts2"

#' Prague NUTS3 code
#'
#' Prague NUTS3 code, level of kraj. Comes from CZSO registry 108 - NUTS3-2004.
#'
#' @format character vector of length 1
#' \describe{
#'   Prague NUTS3 code
#' }
#' @family Codes and metadata
"prg_nuts3"

#' Prague LAU1 code
#'
#' Prague LAU1 code - level of okres.
#'
#' @format character vector of length 1
#' \describe{
#'   Prague LAU1 code. Comes from CZSO registry 109 - OKRES_LAU.
#' }
#' @family Codes and metadata
"prg_lau1"

#' Prague 'okres' code
#'
#' Prague 'okres' code. Comes from CZSO registry 101 - OKRES_NUTS.
#'
#' @format character vector of length 1
#' \describe{
#'   Prague okres code
#' }
#' @family Codes and metadata
"prg_okres"

#' Prague 'kraj' code
#'
#' Prague 'kraj' code. Comes from CZSO registry 100, KRAJ_NUTS.
#'
#' @format character vector of length 1
#' \describe{
#'   Prague kraj code
#' }
#' @family Codes and metadata
"prg_kraj"

#' Prague 'okres LAU' code
#'
#' Prague 'okres LAU' code. Comes from CZSO register 101 (OKRES_NUTS) - yes these are
#' confusing but that is how it is.
#'
#' @format character vector of length 1
#' \describe{
#'   Prague okres (NUTS) code.
#' }
#' @family Codes and metadata
"prg_okres_nuts"

#' Prague code in OECD database of Functional Urban Areas
#'
#' Prague code in OECD Functional Urban Area database.
#'
#' See https://www.oecd.org/cfe/regional-policy/functionalurbanareasbycountry.htmz
#'
#' @format character vector of length 1
#' \describe{
#'   Prague code in OECD Functional Urban Area database.
#' }
#' @family Codes and metadata
"prg_fua_oecd"

#' Prague code in OECD CITIES database of data on Functional Urban Areas
#'
#' Prague code in OECD database on Metropolitan Areas.
#'
#' See https://stats.oecd.org/Index.aspx?DataSetCode=CITIES
#'
#' @format character vector of length 1
#' \describe{
#'   Prague code in OECD Functional Urban Area database.
#' }
#' @family Codes and metadata
"prg_metro_oecd"

#' Prague bbox in EPSG 4326 (WGS 84)
#'
#' Prague bbox in EPSG 4326 (WGS 84)
#'
#' @format named numeric of class `bbox`, length 4
#' \describe{
#'   Prague RUIAN code
#' }
#' @family Codes and metadata
"prg_bbox_wgs84"

#' Prague bbox in EPSG 5514 (Krovak)
#'
#' Prague bbox in EPSG 5514 (Krovak)
#'
#' @format named numeric of class `bbox`, length 4
#' \describe{
#'   Prague RUIAN code
#' }
#' @family Codes and metadata
"prg_bbox_krovak"


# Hexogram ----------------------------------------------------------------

#' Equal-area hexogram of Prague districts
#'
#' Equal-area hexogram of 57 Prague districts. Best available representation
#' though some district tiles neighbor districts they do not in reality.
#'
#' @format A data frame with 57 rows and 11 variables:
#' \describe{
#'   \item{\code{kod}}{character. RUIAN code.}
#'   \item{\code{nazev}}{character. Full name.}
#'   \item{\code{label}}{character. Three-character unique label.}
#'   \item{\code{mop_kod}}{character. Prague district code.}
#'   \item{\code{spo_kod}}{character. Admin district code.}
#'   \item{\code{pou_kod}}{character. Higher-level unit code.}
#'   \item{\code{okres_kod}}{character. District code.}
#'   \item{\code{CENTROIX}}{double. X coordinate of centroid.}
#'   \item{\code{CENTROIY}}{double. Y coordinate of centroid.}
#'   \item{\code{row}}{integer. row number.}
#'   \item{\code{col}}{integer. column number.}
#'   \item{\code{geometry}}{list. geometry.}
#' }
#' @family Mapping
"district_hexogram"

# Tilegram ----------------------------------------------------------------

#' Equal-area tilegram of Prague districts
#'
#' Equal-area tilegram of 57 Prague districts. Best available representation
#' though some district tiles neighbor districts they do not in reality.
#'
#' @format A data frame with 57 rows and 11 variables:
#' \describe{
#'   \item{\code{kod}}{character. RUIAN code.}
#'   \item{\code{nazev}}{character. Full name.}
#'   \item{\code{label}}{character. Three-character unique label.}
#'   \item{\code{mop_kod}}{character. Prague district code.}
#'   \item{\code{spo_kod}}{character. Admin district code.}
#'   \item{\code{pou_kod}}{character. Higher-level unit code.}
#'   \item{\code{okres_kod}}{character. District code.}
#'   \item{\code{CENTROIX}}{double. X coordinate of centroid.}
#'   \item{\code{CENTROIY}}{double. Y coordinate of centroid.}
#'   \item{\code{row}}{integer. row number.}
#'   \item{\code{col}}{integer. column number.}
#'   \item{\code{geometry}}{list. geometry.}
#' }
#' @family Mapping
"district_tilegram"

# Geofacet grid --------------------------------------------------------------

#' Dataset to be used in the {geofacet} package
#'
#' Use this as the `grid` argument to `geofacet::facet_geo()`. The layout corresponds to `district_tilegram`.
#'
#' @format A data frame with 57 rows and 11 variables:
#' \describe{
#'   \item{\code{code}}{character. RUIAN code. Normally should serve as ID to distribute your data points into grid cells.}
#'   \item{\code{label}}{character. Three-character unique label.}
#'   \item{\code{row}}{integer. row number.}
#'   \item{\code{col}}{integer. column number.}
#' }
#' @family Mapping
"district_geofacet"

# District names --------------------------------------------------------------

#' Table of several variants of each districts names, with code
#'
#' For when a shorter label is needed or for linking with other data by name.
#'
#' @format A data frame with 57 rows and 11 variables:
#' \describe{
#'   \item{\code{kod}}{character. RUIAN code.}
#'   \item{\code{label}}{character. Three-character unique label.}
#'   \item{\code{nazev}}{integer. full name.}
#'   \item{\code{name_medium}}{integer. shortened name.}
#'   \item{\code{name_short}}{integer. short name.}
#'   \item{\code{name_spaced}}{integer. full name with spaced dash.}
#' }
#' @family Mapping
"district_names"

# Map server endpoints ----------------------------------------------------

#' IPR Map Services
#'
#' Contains information on a selection of available Prague raster map services.
#' Can be used manually to inspect services and is used internally by
#' prg_tile() and prg_basemap() for retrieving data from servers.
#'
#' @format A data frame with 18 rows and 5 variables:
#' \describe{
#'   \item{\code{name}}{character. Name of the service, to be used as parameter in prg_tile() and prg_basemap()}
#'   \item{\code{type}}{character. "tile" or "image"}
#'   \item{\code{description}}{character. Description of the map source}
#'   \item{\code{endpoint}}{character. endpoint. Used internally}
#'   \item{\code{url}}{character. URL, used internally but also points to human readable interface.}
#' }
#' @family Mapping
"prg_endpoints"


# District demographics ---------------------------------------------------

#' District population by age and sex
#'
#' Population of each of the 57 districts by 5-year age groups and sex, 2011-2019, from the Czech Statistical Office
#'
#' Source: https://www.czso.cz/csu/xa/casove-rady-za-mestske-casti-prahy
#'
#' @format A data frame with 9747 rows and 5 variables:
#' \describe{
#'   \item{\code{KOD_ZUJ}}{character. district code (ZUJ code, CZSO codelist 51 http://apl.czso.cz/iSMS/cisdet.jsp?kodcis=51)}
#'   \item{\code{KOD_SO}}{character. admin. district code (CZSO codelist 72 - CISSOP http://apl.czso.cz/iSMS/cisdet.jsp?kodcis=72)}
#'   \item{\code{count}}{double. number of residents.}
#'   \item{\code{age}}{integer. 5-year age group, except 85+.}
#'   \item{\code{year}}{integer. Year; data for 31. 12.}
#'   \item{\code{sex}}{character. Sex.}
#' }
#' @family Statistics
"district_age_structure"


#' Median age by district
#'
#' Median age of each of the 57 districts by 5-year age groups and sex, 2011-2019, from the Czech Statistical Office
#'
#' Source: https://www.czso.cz/csu/xa/casove-rady-za-mestske-casti-prahy
#'
#' @format A data frame with 1539 rows and 4 variables:
#' \describe{
#'   \item{\code{sex}}{character. Sex}
#'   \item{\code{year}}{integer. Year, 2011-2019}
#'   \item{\code{median_age}}{double. Median age.}
#'   \item{\code{KOD_ZUJ}}{character. district code (ZUJ code, CZSO codelist 51 http://apl.czso.cz/iSMS/cisdet.jsp?kodcis=51)}
#' }
#' @family Statistics
"district_age_median"