R/dolrgrowthlearning.R

In etam4260/dolr: An R interface for accessing DOL (US Department of Labor) APIs

#library for http requests
#library to sanitize strings
#' @import stringr

# Expanding Growth Opportunities and Learning
#   - OIT Initial Claims
#   - OUI Initial Claims V1
#   - IPIA V1
#   - Quarterly Census Employment and Wage (CEW) V1
#   - Occupational Employment Statistics Survey (OES) V1
#   - Current Population Survey (CPS) V1
#   - Current Employment Statistics (CES) V1
#   - Consumer Price Indexes (CPI) V1
#   - 2010 Workforce Investment Act V1
#   - 2010 Occupational Employment Statistics V1
#   - BLS Numbers V1


#' @name dol_gol
#' @title dol_gol
#' @description This function queries the US Department of Labor Expanding Growth Opportunities and Learning Datasets. The datasets currently use V1 of DOL API.
#' @param dataset There are currently 11 datasets to choose from. Specify the one you want with a number from 1-11.
#'   1) OIT Initial Claims
#'   2) OUI Initial Claims V1
#'   3) IPIA V1
#'   4) Quarterly Census Employment and Wage (CEW) V1
#'   5) Occupational Employment Statistics Survey (OES) V1
#'   6) Current Population Survey (CPS) V1
#'   7) Current Employment Statistics (CES) V1
#'   8) Consumer Price Indexes (CPI) V1
#'   9) 2010 Workforce Investment Act V1
#'   10) 2010 Occupational Employment Statistics V1
#'   11) BLS Numbers V1
#' @param sheet For each dataset chosen, there are sub sheets within them. You must specify which sub-sheet you want.
#' @param key The API key for this user. You must go to the DOL and sign up for an account and request for an API key.
#' @keywords Expanding Growth Opportunities and Learning
#' @export
#' @returns A dataframe
dol_gol <- function(dataset = 1, sheet = 1, key = Sys.getenv("DOL_KEY")) {
  if(is.null(key)) stop("You need to supply the key argument or set a key using dolsetkey()")

  # Remove trialing whitespace and convert everything into integers.
  dataset <- as.integer(paste(str_trim(as.character(dataset), side = "both")))
  sheet <- as.integer(paste(str_trim(as.character(sheet), side = "both")))
  key <- paste(str_trim(as.character(key), side = "both"))

  if(dataset <= 0 || dataset >= 14) stop("Dataset number of out of bounds.")

  data <- switch(dataset,
                 'Statistics/PWSD',
                 'Statistics/OUI_InitialClaims',
                 'IPIA',
                 'Statistics/CEW',
                 'Statistics/OES/$metadata',
                 'Statistics/CPS',
                 'Statistics/CES',
                 'Statistics/CPI',
                 'Statistics/WIA',
                 'Statistics/OES2010',
                 'statistics/BLS_Numbers',
  )

  return(query_API_1(data, sheet, key))
}