Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

EIAdata

Provides programmatic access to the Energy Information Administration's API.
https://github.com/Matt-Brigida/EIAdata

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

Last synced: 25 minutes ago
JSON representation

Repository metadata

R Wrapper for the Energy Information Administration (EIA) API

README.md

EIAdata

R Wrapper for the Energy Information Administration (EIA) API.

EIAdata has been updated for v2 of the EIA API. To pull an energy series you'll have to know the Series ID from the version 1 API. If you don't know the Series IDs for the data you want, do the following:

  1. Go to EIA's Opendata website.
  2. Go to the "Bulk File Downloads" by scrolling down a bit and looking on the right margin.
  3. Choose the bulk download for the category that contains the series you want. Foe example if it is a Crude Oil series download the "Petroleum" file.
  4. After the file downloads unzip it and find the Series ID you want.

Note you only have to do the above once to get the Series ID.

This package provides programmatic access to the Energy Information Administration's (EIA) API (See http://www.eia.gov/beta/api/). There are currently over a million unique time series available through the API. To use the package you'll need a free API key from here: http://www.eia.gov/beta/api/register.cfm

The package also contains a function to return the latest EIA Weekly Natural Gas Storage Report. This function does not require an API key.

The package has 2 1 main functions, getCatEIA and getEIA.

  • getCatEIA: allows you to query the parent and subcategories of a given category, as well as any series IDs within that category.

  • getEIA: allows you to pull a time series (given by the series ID). The resulting object is of class xts.

This is the development version. You may prefer to install the version on CRAN here: http://cran.r-project.org/web/packages/EIAdata/index.html

If you would like to install this development version, install the devtools package and use:

library(devtools)
install_github("Matt-Brigida/EIAdata")

If you have the CRAN version and simply want to test the development version you can use:

library(devtools)
dev_mode(on = T)
install_github("Matt-Brigida/EIAdata")
## test the package
## and when you are done
dev_mode(on = F)
## and you are again using the CRAN version

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 89
Total Committers: 5
Avg Commits per committer: 17.8
Development Distribution Score (DDS): 0.101

Commits in past year: 21
Committers in past year: 2
Avg Commits per committer in past year: 10.5
Development Distribution Score (DDS) in past year: 0.095

Name Email Commits
Matt Brigida m****a@g****m 80
Aaron Brown a****n@m****m 4
Steve Putman s****n@g****m 2
Danny1127 z****n@q****m 2
sy2816 s****6@g****m 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 16
Total pull requests: 6
Average time to close issues: 10 months
Average time to close pull requests: 3 months
Total issue authors: 9
Total pull request authors: 5
Average comments per issue: 3.0
Average comments per pull request: 1.5
Merged pull request: 5
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/Matt-Brigida/EIAdata

Top Issue Authors

  • Matt-Brigida (5)
  • sawyervillers (3)
  • jlprol (2)
  • statistical-lusardi (1)
  • hm-yuan (1)
  • JohannesEmm (1)
  • BuddyAnderson (1)
  • MoreCoffee12 (1)
  • Islascuevas (1)

Top Pull Request Authors

  • steveputman (2)
  • Danny1127 (1)
  • sy2816 (1)
  • bramtayl (1)
  • brownaa (1)

Top Issue Labels

Top Pull Request Labels

Package metadata

cran.r-project.org: EIAdata

R Wrapper for the Energy Information Administration (EIA) API

  • Homepage: https://github.com/Matt-Brigida/EIAdata
  • Status: removed
  • Documentation: http://cran.r-project.org/web/packages/EIAdata/EIAdata.pdf
  • Licenses: GPL-2
  • Latest release: 0.1.3 (published about 3 years ago)
  • Last Synced: 2025-04-26T13:34:32.379Z (1 day ago)
  • Versions: 7
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Docker Downloads: 20,358
  • Rankings:
    • Forks count: 5.307%
    • Stargazers count: 13.78%
    • Average: 18.311%
    • Dependent packages count: 18.704%
    • Dependent repos count: 35.455%
  • Maintainers (1)

Dependencies

DESCRIPTION cran
  • R >= 2.11.0 depends
  • XML * depends
  • httr * depends
  • xts * depends
  • zoo * depends

Score: 14.303452332341022