eia2tidy_all: EIA API multiple calls with tidy output

View source: R/eia2tidy_all.R

eia2tidy_allR Documentation

EIA API multiple calls with tidy output

Description

Extracts data from the Energy Information Administration (EIA) API to tibble format with optional custom series name. Makes a clean wrapper for use with purrr for multiple series extraction. Query Browser at https://www.eia.gov/opendata/qb.php.

Usage

eia2tidy_all(
  tickers = tibble::tribble(~ticker, ~name, "PET.W_EPC0_SAX_YCUOK_MBBL.W",
    "CrudeCushing", "NG.NW2_EPG0_SWO_R48_BCF.W", "NGLower48"),
  key,
  long = TRUE
)

Arguments

tickers

tribble of EIA series and names you want to assign.

key

Your private EIA API token as character "yourapikey".

long

TRUE (default) to return a long data frame or FASLE for wide

Value

A tibble object with class date for weekly, monthly, quarterly or annual data and class POSIXct for hourly.

Author(s)

Philippe Cote

Examples

## Not run: 
eia2tidy_all(tickers = tibble::tribble(~ticker, ~name,
                         "PET.W_EPC0_SAX_YCUOK_MBBL.W", "CrudeCushing",
                         "NG.NW2_EPG0_SWO_R48_BCF.W", "NGLower48"),
            key = "your API key", long = TRUE)

## End(Not run)

RTL documentation built on Jan. 9, 2023, 1:25 a.m.