R/validate_district.R

In dietrichson/ProPublicaR: Access Functions for ProPublica's APIs

#' Validate that a district abbreviation is correct
#'
#' @param us_district An integer corresponding to the district.
#'
#' @return TRUE if correct FALSE otherwise
#' @export
#' @import stringr
#' @include data.R
#' @examples
#' \dontrun{
#' validate_district(1)#TRUE
#' validate_district(111) #FALSE
#' validate_district(us_congressional_districts$district[1]) #FALSE
#' validate_district(as.numeric(us_congressional_districts$district_number[1])) #TRUE
#' }
validate_district <- function(us_district) {
  if (!is.numeric(us_district))
    warning("District Abbreviation should be a numeric")
  us_congressional_districts <- us_congressional_districts
  us_district %in% us_congressional_districts$district_number
}