EIA

An R package wrapping the US Energy Information Administration open data API.
https://github.com/ropensci/eia

Category: Energy Systems
Sub Category: Energy Data Accessibility and Integration

Keywords

cran eia eia-api energy-data energy-information-administration open-data r-package

Keywords from Contributors

geocoding

Last synced: about 18 hours ago
JSON representation

Repository metadata

An R package wrapping the US Energy Information Administration open data API.

• Host: GitHub
• URL: https://github.com/ropensci/eia
• Owner: ropensci
• License: other
• Created: 2019-06-26T17:24:27.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-19T21:54:15.000Z (10 months ago)
• Last Synced: 2025-05-02T15:37:02.632Z (16 days ago)
• Topics: cran, eia, eia-api, energy-data, energy-information-administration, open-data, r-package
• Language: R
• Homepage: https://docs.ropensci.org/eia
• Size: 1.36 MB
• Stars: 47
• Watchers: 3
• Forks: 11
• Open Issues: 0
• Releases: 8
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codemeta: codemeta.json

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE, comment = "#>", out.width = "100%",
  fig.path = "man/figures/README-", fig.width = 7, fig.height = 4, dpi = 150,
  message = FALSE, warning = FALSE, error = FALSE
)
library(eia)
library(ggplot2)
```

# eia 


[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)
[![R-CMD-check](https://github.com/ropensci/eia/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/eia/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/ropensci/eia/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ropensci/eia?branch=master)
[![](https://badges.ropensci.org/342_status.svg)](https://github.com/ropensci/software-review/issues/342)
[![CRAN status](https://www.r-pkg.org/badges/version/eia)](https://cran.r-project.org/package=eia)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/eia)](https://cran.r-project.org/package=eia)
[![Github Stars](https://img.shields.io/github/stars/ropensci/eia.svg?style=social&label=Github)](https://github.com/ropensci/eia)


The `eia` package provides API access to data from the US [Energy Information Administration](https://www.eia.gov/) (EIA).

Pulling data from the US Energy Information Administration (EIA) API requires a registered API key.
A key can be obtained at no cost [here](https://www.eia.gov/opendata/register.php).
A valid email and agreement to the API Terms of Service is required to obtain a key.

`eia` includes functions for searching the EIA API data directory and importing various datasets.
Datasets returned by these functions are provided in a tidy format or alternatively in more raw form.
It also offers helper functions for working with EIA API date strings and time formats and for
inspecting different summaries of data metadata. The package also provides control over API key
storage and caching of API request results.

## Installation

Install the CRAN release of `eia` with

```{r instl1, eval=FALSE}
install.packages("eia")
```

or install the development version from GitHub with

```{r instl2, eval=FALSE}
# install.packages("remotes")
remotes::install_github("ropensci/eia")
```

## Example

After obtaining the API key, store it somewhere such as `.Renviron` and never have
to do anything with the key when using the package. Alternatively, set it manually
with `eia_set_key()` in the current R session. Further, it can always be passed
explicitly to the `key` argument of a given `eia` function.

### Load package and set key

```{r xmpl1, eval=FALSE}
library(eia)

# not run
eia_set_key("yourkey") # set API key if not already set globally
```

### Explore the API directory

Get a list of the EIA's data directory (and sub-directories) with `eia_dir()`.

```{r xmpl2}
# Top-level directory
eia_dir()

# Electricity sub-directory
eia_dir("electricity")
```

### Get data

Get annual retail electric sales for the Ohio residential sector since 2010

```{r xmpl3}
(d <- eia_data(
  dir = "electricity/retail-sales",
  data = "sales",
  facets = list(stateid = "OH", sectorid = "RES"),
  freq = "annual",
  start = "2010",
  sort = list(cols = "period", order = "asc"),
))
```

and make a nice plot.

```{r plt}
library(ggplot2)
ggplot(d, aes(x = period, y = sales / 1e3)) +
  geom_bar(col = "steelblue", fill = "steelblue", stat = "identity") +
  theme_bw() +
  labs(
    title = "Annual Retail Sales of Electricity (GWh)",
    subtitle = "State: Ohio; Sector: Residential",
    x = "Year", y = "Sales (GWh)"
  )
```

## References

See the collection of vignette tutorials and examples as well as complete package
documentation available at the `eia` package [website](https://docs.ropensci.org/eia/).

---

Please note that the `eia` project is released with
a [Contributor Code of Conduct](https://github.com/ropensci/eia/blob/master/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.

[![ropensci_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)

        

---

Owner metadata

• Name: rOpenSci
• Login: ropensci
• Email: [email protected]
• Kind: organization
• Description:
• Website: https://ropensci.org/
• Location: Berkeley, CA
• Twitter: rOpenSci
• Company:
• Icon url: https://avatars.githubusercontent.com/u/1200269?v=4
• Repositories: 307
• Last ynced at: 2023-03-10T20:30:59.242Z
• Profile URL: https://github.com/ropensci

---

GitHub Events

Total

• Watch event: 4
• Fork event: 5

Last Year

• Watch event: 4
• Fork event: 5

---

Committers metadata

Last synced: 9 days ago

Name	Email	Commits
Matthew Hoff	m****f@g****m	162
leonawicz	m****z@e****m	102
leonawicz	m****z@g****m	28
Maëlle Salmon	m****n@y****e	2
David Ranzolin	d****n@g****m	1
James Lamb	j****0@g****m	1

Committer domains:

• esource.com: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ropensci/eia

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • cran: 297 last-month
• Total dependent packages: 0
• Total dependent repositories: 1
• Total versions: 8
• Total maintainers: 1

---

Dependencies

Score: 11.3423506443288