R/get_nonlegislative_district.R

In daranzolin/rcicero: This package is a wrapper for the Cicero API

#' get_nonlegislative_district
#'
#' @importFrom magrittr "%>%"
#' @importFrom httr stop_for_status GET content
#' @importFrom tidyjson as.tbl_json spread_values jstring enter_object
#' @importFrom dplyr select as_data_frame
#'
#' @param search_loc a string containing a street address
#'
#' @param lat latitude coordinate
#'
#' @param lon longitude coordinate
#'
#' @param type a string, nonlegislative district type that is either: CENSUS, COUNTY, JUDICIAL, POLICE, SCHOOL, or WATERSHED
#'
#' @return data_frame
#' @export
#'
#' @examples
#' #' get_nonlegislative_district(search_loc = "3175 Bowers Ave. Santa Clara, CA, type = "SCHOOL")
get_nonlegislative_district <- function(search_loc = NULL, lat = NULL, lon = NULL,
                                        type = "SCHOOL") {
  if (!type %in% c("CENSUS", "COUNTY", "JUDICIAL", "POLICE", "SCHOOL", "WATERSHED") || length(type) != 1) {
    stop("type argument must be one of CENSUS, COUNTY, JUDICIAL, POLICE, SCHOOL, or WATERSHED")
  }

  args <- sc(
    list(
      key = check_key(),
      token = check_token(),
      user = check_user(),
      search_loc = search_loc,
      lat = lat,
      lon = lon,
      type = type,
      format = "json"
      )
    )

  json <- cicero_query("/nonlegislative_district", args, "text")

  if (!is.null(search_loc)) {
    df <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("candidates") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(address = tidyjson::jstring("match_addr"),
                              latitude = tidyjson::jstring("y"),
                              longitude = tidyjson::jstring("x")) %>%
      tidyjson::enter_object("districts") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(district_type = tidyjson::jstring("district_type"),
                              label = tidyjson::jstring("label"),
                              district_id = tidyjson::jstring("district_id"),
                              subtype = tidyjson::jstring("subtype"),
                              state = tidyjson::jstring("state"),
                              last_updated = tidyjson::jstring("last_update_date"),
                              id = tidyjson::jnumber("id")
      )
  } else {
    df <- json %>% tidyjson::as.tbl_json() %>%
      tidyjson::enter_object("response") %>%
      tidyjson::enter_object("results") %>%
      tidyjson::enter_object("districts") %>% tidyjson::gather_array() %>%
      tidyjson::spread_values(district_type = tidyjson::jstring("district_type"),
                              label = tidyjson::jstring("label"),
                              district_id = tidyjson::jstring("district_id"),
                              subtype = tidyjson::jstring("subtype"),
                              state = tidyjson::jstring("state"),
                              last_updated = tidyjson::jstring("last_update_date"),
                              id = tidyjson::jnumber("id")
      )
  }
  df <- df %>%
    format_df()
  return(df)
}