R/gisco-get-census.R

In giscoR: Download Map Data from GISCO API - Eurostat

#' Census dataset
#'
#' This dataset shows pan European communal boundaries depicting the situation
#' at the corresponding Census.
#'
#' @family stats
#' @inheritParams gisco_get_countries
#' @inherit gisco_get_countries return
#' @export
#'
#' @seealso
#'
#' See [gisco_id_api_census_grid()] to download via GISCO ID service API.

#'
#' @param year character string or number. Release year of the file. Currently
#'   only `"2011"` is provided.
#' @param spatialtype Type of geometry to be returned:
#'  * `"PT"`: Points - `POINT` object.
#'  * `"RG"`: Regions - `MULTIPOLYGON/POLYGON` object.
#'
#' @source
#' <https://ec.europa.eu/eurostat/web/gisco/geodata/statistical-units/census>.
#'
#' Copyright:
#' <https://ec.europa.eu/eurostat/web/gisco/geodata/statistical-units>.
#'
#' @examplesIf gisco_check_access()
#' \donttest{
#' library(sf)
#'
#' pts <- gisco_get_census(spatialtype = "PT")
#'
#' pts
#' }
gisco_get_census <- function(
  year = 2011,
  cache_dir = NULL,
  update_cache = FALSE,
  verbose = FALSE,
  spatialtype = c("RG", "PT")
) {
  year <- match_arg_pretty(year)

  spatialtype <- match_arg_pretty(spatialtype)
  if (spatialtype == "PT") {
    url <- paste0(
      "https://ec.europa.eu/eurostat/cache/GISCO/",
      "geodatafiles/CENSUS_UNITS_PT_2011_SH.zip"
    )
  } else {
    url <- paste0(
      "https://ec.europa.eu/eurostat/cache/GISCO/",
      "geodatafiles/CENSUS_UNITS_2011_RG_SH.zip"
    )
  }
  filename <- basename(url)
  namefileload <- download_url(
    url,
    filename,
    cache_dir,
    "census",
    update_cache,
    verbose
  )

  if (is.null(namefileload)) {
    return(NULL)
  }

  data_sf <- read_geo_file_sf(namefileload)

  # Normalize to lonlat
  data_sf <- sf::st_transform(data_sf, 4326)
  data_sf
}