eia_bulk_data: Bulk download data from the EIA API

Description Usage Arguments Value Author(s) Examples

Description

This function accesses EIA bulk files. (The EIA bulk download facility does not require a registered user API key.)

Usage

1
2
eia_bulk_data(dataset, simplify = TRUE, data_only = TRUE,
  update_cache = FALSE)

Arguments

dataset

EIA bulk download data set identifier. This argument will accept a regular expression search string and download all matching bulk download data sets. If dataset="All", all bulk download data files will be downloaded and returned in an R data frame.

simplify

Logical. If TRUE, the function returns EIA data in data frame objects. If FALSE, function returns raw JSON formatted source.

data_only

Logical. If TRUE (the default), returns only EIA series data, in a data frame. If FALSE it returns data and category classification information. (Presently only applies to simplified data.)

update_cache

Logical expression, if FALSE (default), use the cached list of available ABS.Stat datasets, if TRUE, update the list of available datasets.

Value

Returns either a data frame with EIA bulk series data or a list containing EIA bulk series data and associatioed catalogue information.

Author(s)

David Mitchell <david.pk.mitchell@gmail.com>

Examples

1
2
3
4
  
    ## Fetch Annual Energy Outlook 2019 bulk data
    eia_ieo <- eia_bulk_data(dataset="AEO.2019");
  

mitcda/eiastats documentation built on May 8, 2019, 12:48 p.m.