R/BEAData_utilities.r

In donboyd5/BEAData: BEA Data Files

#' @import tidyverse
NULL


#' Get a data frame with the GDP price index, either annual or quarterly.
#'
#' @param gfreq "A" (annual) or "Q" (quarterly). Defaults to "A".
#' @return data frame with:
#'
#'    year (integer), gdppi (double) if freq=="A"
#'
#'    date (date), gdppi (double) if freq=="Q"
#'
#' @export
#' @examples
#' library("tidyverse")
#' getgdppi()
#' getgdppi("Q")
getgdppi <- function(gfreq="A"){
  requireNamespace("tidyverse", quietly = TRUE)
  vname <- freq <- date <- year <- value <- NULL # fool R CMD check
  gdppi <- BEAData::nipa %>%
    dplyr::filter(vname=="A191RG", freq==gfreq) %>%
    dplyr::select(date, year, freq, gdppi=value)
  return(gdppi)
}


#' Get a data frame with real gdp, nominal gdp and the gdp price index, annual or quarterly.
#'
#' @param gfreq "A" (annual) or "Q" (quarterly). Defaults to "A".
#' @return data frame with:
#'
#'    year (integer), rgdp, gdp, gdppi (double), if freq=="A"
#'
#'    date (date), rgdp, gdp, gdppi (double) if freq=="Q"
#'
#' @export
#' @examples
#' library("tidyverse")
#' getgdp()
#' getgdp("A")
#' getgdp("Q")
getgdp <- function(gfreq="A"){
  requireNamespace("tidyverse", quietly = TRUE)
  vname <- freq <- date <- year <- value <- A191RX <- A191RC <- A191RG <- NULL # fool R CMD check
  period <- ifelse(gfreq=="A", "year", "date")
  gdp <- BEAData::nipa %>%
    dplyr::filter(vname %in% c("A191RX", "A191RC", "A191RG"), freq==gfreq) %>% # real gdp, nominal gdp, gdp price index
    dplyr::select(period, vname, value) %>%
    tidyr::spread(vname, value) %>%
    dplyr::select(period, rgdp=A191RX, gdp=A191RC, gdppi=A191RG)
  return(gdp)
}


#' Get a data frame with a set of NIPA variables, annual or quarterly.
#'
#' @param vars a vector of NIPA variable names
#' @param gfreq "A" (annual) or "Q" (quarterly). Defaults to "A".
#' @return data frame with:
#'
#'    year (integer), vname, value (double), if freq=="A"
#'
#'    date (date), vname, value (double) if freq=="Q"
#'
#' @export
#' @examples
#' library("tidyverse")
#' vars <- c("A191RX", "A191RG")
#' getNIPAvars(vars, gfreq="A")
#' getNIPAvars(vars, gfreq="Q")
getNIPAvars <- function(vars, gfreq="A"){
  requireNamespace("tidyverse", quietly = TRUE)
  vname <- freq <- date <- year <- value <- NULL # fool R CMD check
  period <- ifelse(gfreq=="A", "year", "date")
  df <- BEAData::nipa %>%
    dplyr::filter(vname %in% vars, freq==gfreq) %>%
    dplyr::select(period, vname, value)
  return(df)
}


#' Return a NIPA table descriptive information as a data frame.
#'
#' @param gtabnum BEA table number to get, as character, with no trailing period. For example, "1.1.1"
#' @return data frame sorted by line number, with:
#'
#'    vname   BEA variable (series) name
#'
#'    line    line number
#'
#'    vdesc   variable description
#'
#'    tabname full table name
#'
#' @export
#' @examples
#' library("tidyverse")
#' getNIPATable("1.1.1")
#' getNIPATable("3.3")
getNIPATable <- function(gtabnum) {
  requireNamespace("tidyverse", quietly = TRUE)
  tabnum <- line <- vname <- vdesc <- tabname <- NULL # fool R CMD check
  BEAData::NIPAvars %>%
    dplyr::filter(tabnum==gtabnum) %>%
    dplyr::arrange(line) %>%
    dplyr::select(vname, line, vdesc, tabname)
}


#' Return a NIPA table descriptive information as a data frame, with data for 2 latest years.
#'
#' @param gtabnum BEA table number to get, as character, with no trailing period. For example, "1.1.1"
#' @return data frame sorted by line number, with:
#'
#'    vname   BEA variable (series) name
#'
#'    line    line number
#'
#'    vdesc   variable description
#'
#'    ynum1   value for 2nd-to-latest year
#'
#'    ynum2   value for latest year
#'
#'    tabname full table name
#'
#' @export
#' @examples
#' library("tidyverse")
#' getNIPATableValue("1.1.1")
#' getNIPATableValue("3.3")
getNIPATableValue <- function(gtabnum) {
  requireNamespace("tidyverse", quietly = TRUE)
  tabnum <- line <- vname <- vdesc <- tabname <- freq <- year <- value <- NULL # fool R CMD check
  maxyear <- BEAData::nipa[BEAData::nipa$freq=="A", ]$year %>% max
  df <- getNIPATable(gtabnum)
  df2 <- BEAData::nipa %>%
    dplyr::filter(freq=="A",
           vname %in% df$vname,
           year %in% (maxyear - 1):maxyear) %>%
    dplyr::select(vname, year, value) %>%
    dplyr::mutate(year=paste0("y", year)) %>%
    tidyr::spread(year, value)
  df3 <- df %>%
    dplyr::left_join(df2) %>%
    dplyr::select(vname, line, vdesc, dplyr::starts_with("y"), tabname)
  return(df3)
}


#' Get a data frame with information on a variable in a specific BEA table and line number.
#'
#' @param gtabnum BEA table number of desired variable, as character, with no trailing period. For example, "1.1.1".
#' @param gline Line number to get, integer.
#' @return A one-row data frame for the variable, with:
#'
#'    tabnum  BEA table number (just the number, as character)
#'
#'    line    line number
#'
#'    vname   BEA variable (series) name
#'
#'    vdesc   variable description
#'
#'    tabname full table name
#'
#' @export
#' @examples
#' library("tidyverse")
#' getNIPAvarinfo("3.3", 1)
#' getNIPAvarinfo("2.3.2", 4)
getNIPAvarinfo <- function(gtabnum, gline){
  requireNamespace("tidyverse", quietly = TRUE)
  tabnum <- line <- vname <- vdesc <- tabname <- NULL # fool R CMD check
  vname <- BEAData::NIPAvars %>%
    dplyr::filter(tabnum==gtabnum, line==gline) %>%
    dplyr::select(tabnum, line, vname, vdesc, tabname)
  return(vname)
}