R/z11_get_100m_attribute.R

In StefanJuenger/z11: R Interface to the German Census 2011 Raster Data

#' Retrieve 1 hectare attribute of the German Census 2011
#'
#' This function retrieves an attribute with a raster resolution of 1 hectare.
#' You can either choose to have it converted directly into the raster format
#' (default) or you can return it as a `sf` tibble object with point
#' geometries.
#'
#' @param attribute attribute name as definded in
#' \code{z11::z11_list_100m_attributes}
#' @param as_raster logical; shall the attribute be returned as raster or sf
#' object
#' @param data_location character string; location of the downloaded census data
#' from https://github.com/StefanJuenger/z11data; default is NULL - data are
#' downloaded from the internet
#'
#' @return Raster or sf
#'
#' @importFrom magrittr %>%
#'
#' @export
z11_get_100m_attribute <-
  function(attribute, as_raster = TRUE, data_location = NULL) {

  attribute <- rlang::enquo(attribute) %>% rlang::as_label()

  # load data in session
  if (is.null(data_location)) {
  requested_attribute <-
    paste0(
      "https://github.com/StefanJuenger/z11data/raw/main/100m/",
      attribute,
      ".rds"
    ) %>%
    url("rb") %>%
    readRDS()
  } else {
    requested_attribute <-
      paste0(data_location, "/100m/", attribute, ".rds") %>%
      readRDS()
  }

  # extract coordinates from inspire id
  requested_attribute <-
    requested_attribute %>%
    dplyr::bind_cols(
      z11_extract_inspire_coordinates(.$Gitter_ID_100m)
    ) %>%
    sf::st_as_sf(coords = c("X", "Y"), crs = 3035)

  if (isTRUE(as_raster)) {
    requested_attribute <-
      requested_attribute %>%
      stars::st_rasterize(dx = 100, dy = 100) %>%
      terra::rast()

    requested_attribute
  } else {
    requested_attribute
  }
}