Obtain EIA data metadata
Usage
eia_metadata(dir, tidy = TRUE, cache = TRUE, key = eia_get_key())
Arguments
- dir
character, directory path.
- tidy
logical, return a tidier result. See details.
- cache
logical, cache result for duration of R session using memoization. See details.
- key
API key: character if set explicitly; not needed if key is set globally. See
eia_set_key()
.
Details
By default, additional processing is done to return a list containing tibble data frames.
Set tidy = FALSE
to return only the initial list result of jsonlite::fromJSON()
.
Set tidy = NA
to return the original JSON as a character string.
Set to cache = FALSE
to force a new API call for updated data.
Using FALSE
always makes a new API call and returns the result from the server.
TRUE
uses memoization on a per R session basis, caching the result of the
function call in memory for the duration of the R session.
You can reset the entire cache by calling eia_clear_cache()
.
Examples
if (FALSE) { # \dontrun{
eia_dir("electricity/retail-sales")
eia_metadata("electricity/retail-sales")
} # }