R/make-single-family-criteria.R

In tiernanmartin/NeighborhoodChangeTypology: Project: Neighborhood Change Typology for King County, WA

#' @title Make the Criteria for Single Family Housing Parcels
#' @description Make the criteria used to identify the single family
#'   parcels that will be used to identify housing market characteristics.
#' @return a list
#' @importFrom units set_units
#' @importFrom dplyr filter
#' @importFrom stringr str_detect
#' @importFrom purrr pluck
#' @export
make_single_family_criteria <- function(present_use_key){

  sf_uses_all <- present_use_key %>%
    dplyr::filter(stringr::str_detect(META_PRESENT_USE_DESC, "Single Family")) %>% # this excludes `Vacant(Single-family)`
    purrr::pluck("META_PRESENT_USE_DESC")

  sf_uses <- c("Single Family(Res Use/Zone)", "Single Family(C/I Zone)") # this exlcudes "Single Family(C/I Use)"

  single_family_criteria <-
    list(
      "present_uses" = sf_uses,
      "tax_years" = c(2005, 2010, 2013, 2014, 2015, 2016, 2017, 2018),
      "remained_sf" = TRUE,
      "min_impr_value" = 10000,
      "parcel_area" = list(
        "upper" = units::set_units(5, "acre"),
        "lower" = units::set_units(3000, "ft^2")
      ),
      "buildings_on_property" = 2L
    )

  return(single_family_criteria)
}