R/laus_get_areacode.R

In mikeasilva/blsAPI: Request Data from the U.S. Bureau of Labor Statistics API

# laus_get_areacode
#
#' @title Acquire the area code used in the series id for observations in Labor Area Unemployment Statistics (LAUS) data
#' @description Gathers the area code used in the laus_get_data function to acquire a data frame using the blsAPI function that request data through the U.S. Bureau of Labor Statistics API. The laus_get_areacode function is called by the laus_get_data function not the user.
#' @param Location_Name A string or vector of the different cities, states or metropolitan statistical areas you want LAUS data from
#' @details type help_laus_areacodes() to get a list of all of the area names that area associated to an area code in the LAUS data
#' @export laus_get_areacode
#' @return returns a string or vector representing area codes
#' @examples
#' library(blsAPI)
#' laus_get_areacode(Location_Name = c("Florida", "California", 
#'                     "Charlotte County, FL", "Fresno County, CA"))
#' 
laus_get_areacode <- function(Location_Name){
  # Loading in the Area Code rda file
  data("LAUS_AreaCodes", envir = environment())
  #
  laus_df <- subset(LAUS_AreaCodes, LAUS_AreaCodes$area_text %in% Location_Name, select = c("area_code", 'area_text'))
  #
  laus_vector <- laus_df$area_code
  return(laus_vector)
}