R/get_area_property.R

In elipousson/mapbaltimore: Make maps for Baltimore City with open data

#' Get real property data
#'
#' Get showing parcels described as owner occupied, non-owner occupied, vacant,
#' and unimproved. Real property or parcel data is from the Maryland State
#' Department of Assessment and Taxation and may include errors.
#'
#' @inheritParams getdata::get_esri_data
#' @inheritParams get_area_data
#' @param cache If `TRUE`, cache data to mapbaltimore cache folder. Defaults to
#'   `FALSE`.
#' @inheritParams cache_baltimore_data
#' @param ... Additional parameters passed to [getdata::get_esri_data()].
#' @examples
#' get_area_property(
#'   area = neighborhoods[1, ],
#'   dist = -150,
#'   unit = "m"
#' )
#' @export
#' @importFrom sfext as_sf
#' @importFrom getdata get_esri_data format_sf_data
get_area_property <- function(area = NULL,
                              bbox = NULL,
                              dist = NULL,
                              diag_ratio = NULL,
                              unit = "m",
                              asp = NULL,
                              crop = TRUE,
                              trim = FALSE,
                              cache = FALSE,
                              filename = NULL,
                              overwrite = FALSE,
                              ...) {
  url <- "https://geodata.baltimorecity.gov/egis/rest/services/CityView/Realproperty/MapServer/0"

  if (is.null(area) && !is.null(bbox)) {
    location <- sfext::as_sf(bbox)
  } else {
    location <- area
  }

  real_property <-
    getdata::get_esri_data(
      location = location,
      url = url,
      dist = dist,
      diag_ratio = diag_ratio,
      asp = asp,
      unit = unit,
      ...
    )

  real_property <- real_property %>%
    getdata::format_sf_data(
      crop = crop,
      trim = trim
    ) %>%
    format_property_data()

  if (cache) {
    cache_baltimore_data(data = real_property, ...)
  }

  real_property
}

#' @name format_property_data
#' @rdname get_area_property
#' @export
#' @importFrom dplyr mutate across rename if_else
#' @importFrom stringr str_trim str_squish
#' @importFrom glue glue
#' @importFrom tidyr replace_na
format_property_data <- function(data) {
  check_installed("naniar")
  data <- getdata::str_trim_squish_across(data)

  data <- naniar::replace_with_na_if(data, is.character, ~ .x == "")

  data <-
    dplyr::rename(
      data,
      full_address = fulladdr,
      bldg_num = bldg_no,
      street_dir_prefix = stdirpre,
      street_name = st_name,
      street_type = st_type,
      zip_code_ext = extd_zip,
      dhcd_use = dhcduse1,
      agency = respagcy,
      neighborhood = neighbor,
      sale_price = salepric,
      sale_date = saledate,
      zoning = zonecode,
      year_built = year_build
    )

  data <-
    dplyr::mutate(
      data,
      block_num = floor(bldg_num / 100) * 100,
      bldg_num_even_odd = dplyr::if_else((bldg_num %% 2) == 0, "Even", "Odd"),
      block_number_st = glue("{block_num} {street_dir_prefix} {street_name} {street_type}", .na = ""),
      no_imprv = dplyr::if_else(is.na(no_imprv), "N", "Y"),
      vacind = dplyr::if_else(is.na(vacind), "N", "Y")
    )

  data <-
    naniar::replace_with_na(
      data,
      replace = list(year_built = 0)
    )

  dplyr::mutate(
    data,
    vacant_lot = dplyr::if_else(no_imprv == "Y", TRUE, FALSE),
    vacant_bldg = dplyr::if_else(vacind == "Y", TRUE, FALSE)
    # vacant_bldg = dplyr::if_else(!is.na(vbn_issued), TRUE, FALSE)
  )
}