USgrid

The hourly demand and supply of electricity in the US.
https://github.com/RamiKrispin/USgrid

Last synced: 9 months ago
JSON representation

Acceptance Criteria

Repository metadata

The hourly demand and supply of electricity in the US

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# USgrid 


[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![CRAN status](https://www.r-pkg.org/badges/version/USgrid)](https://cran.r-project.org/package=USgrid)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)


The USgrid R package provides a set of high frequency (hourly) time-series datasets, describing the demand and generation of electricity in the US (lower-48 states, excluding Alaska and Hawaii). That includes the following series:

* `US_elec`  - the total hourly demand and supply (generation) for electricity in the US since July 2015

* `US_source` - the US net generation of electricity by energy source (natural gas, coal, solar, etc.) since July 2018

* `Cal_elec` - The California subregion hourly demand by operator since July 2018

All datasets are in [tsibble](https://tsibble.tidyverts.org/index.html) format

**Source:** [US Energy Information Administration](https://www.eia.gov/), Mar 2021

Installation
------------

Install the stable version from [CRAN](https://CRAN.R-project.org/package=USgrid):

``` r
install.packages("USgrid")
```

or install the development version from [Github](https://github.com/RamiKrispin/USgrid):

``` r
# install.packages("remotes")
remotes::install_github("RamiKrispin/USgrid")
```

## Examples

The hourly demand and generation (supply) of electricty in the US:

``` r
library(USgrid)
library(plotly)

data(US_elec)

plot_ly(data = US_elec,
        x = ~ date_time,
        y = ~ series,
        color = ~ type,
        colors = c("#66C2A5","#8DA0CB"),
        type = "scatter",
        mode = "lines") %>%
        layout(title = "US Electricity Demand vs. Supply (Hourly)",
               yaxis = list(title = "Mwh"),
               xaxis = list(title = "Source: US Energy Information Administration (Mar 2021)"))
```

```{r include=FALSE}
library(USgrid)
library(plotly)

data(US_elec)

p1 <- plot_ly(data = US_elec,
        x = ~ date_time,
        y = ~ series,
        color = ~ type,
        colors = c("#66C2A5","#8DA0CB"),
        type = "scatter",
        mode = "lines") %>%
        layout(title = "US Electricity Demand vs. Supply (Hourly)",
               yaxis = list(title = "Mwh"),
               xaxis = list(title = "Source: US Energy Information Administration (Mar 2021)"))

orca(p1, "man/figures/US_elec.svg")
```



The hourly generation (supply) of electricty in the US by source:
``` r
data("US_source")

plot_ly(data = US_source,
        x = ~ date_time,
        y = ~ series,
        color = ~ source,
        type = "scatter",
        mode = "lines") %>%
  layout(title = "US Electricity Generation by Energy Source",
         yaxis = list(title = "Mwh"),
         xaxis = list(title = "Source: US Energy Information Administration (Mar 2021)"))
```


```{r include=FALSE}
data("US_source")

p2 <- plot_ly(data = US_source,
        x = ~ date_time,
        y = ~ series,
        color = ~ source,
        type = "scatter",
        mode = "lines") %>%
  layout(title = "US Electricity Generation by Energy Source",
         yaxis = list(title = "Mwh"),
         xaxis = list(title = "Source: US Energy Information Administration (Dec 2019)"))

orca(p2, "man/figures/US_source.svg")
```



The California subregion hourly demand by operator

``` r
data("Cal_elec")

plot_ly(data = Cal_elec,
        x = ~ date_time,
        y = ~ series,
        color = ~ operator,
        type = "scatter",
        mode = "lines") %>%
  layout(title = "California Hourly Demand by Operator",
         yaxis = list(title = "Mwh"),
         xaxis = list(title = "Source: US Energy Information Administration (Mar 2021)"))
```


```{r include=FALSE}
data("Cal_elec")

p3 <- plot_ly(data = Cal_elec,
        x = ~ date_time,
        y = ~ series,
        color = ~ operator,
        type = "scatter",
        mode = "lines") %>%
  layout(title = "California Hourly Demand by Operator",
         yaxis = list(title = "Mwh"),
         xaxis = list(title = "Source: US Energy Information Administration (Mar 2021)"))

orca(p3, "man/figures/Cal_elec.svg")
```



        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 9 months ago

Total Commits: 136
Total Committers: 3
Avg Commits per committer: 45.333
Development Distribution Score (DDS): 0.176

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
RamiKrispin r****p@u****u 112
--local -****l 12
rkrispin r****n@a****m 12

Committer domains:


Issue and Pull Request metadata

Last synced: 9 months ago

Total issues: 6
Total pull requests: 0
Average time to close issues: 20 days
Average time to close pull requests: N/A
Total issue authors: 1
Total pull request authors: 0
Average comments per issue: 0.5
Average comments per pull request: 0
Merged pull request: 0
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/RamiKrispin/USgrid

Top Issue Authors

  • RamiKrispin (6)

Top Pull Request Authors


Top Issue Labels

  • new feature (3)
  • task (2)
  • enhancement (1)

Top Pull Request Labels


Package metadata

proxy.golang.org: github.com/ramikrispin/usgrid

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/ramikrispin/usgrid#section-documentation
  • Licenses:
  • Latest release: v0.1.2 (published about 4 years ago)
  • Last Synced: 2024-07-24T20:01:41.635Z (9 months ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 6.999%
    • Average: 8.173%
    • Dependent repos count: 9.346%
proxy.golang.org: github.com/RamiKrispin/USgrid

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/RamiKrispin/USgrid#section-documentation
  • Licenses:
  • Latest release: v0.1.2 (published about 4 years ago)
  • Last Synced: 2024-07-24T20:01:43.867Z (9 months ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 6.999%
    • Average: 8.173%
    • Dependent repos count: 9.346%
cran.r-project.org: USgrid

The Demand and Supply for Electricity in the US

  • Homepage: https://github.com/RamiKrispin/USgrid
  • Documentation: http://cran.r-project.org/web/packages/USgrid/USgrid.pdf
  • Licenses: MIT + file LICENSE
  • Latest release: 0.1.2 (published about 4 years ago)
  • Last Synced: 2024-07-24T20:01:43.174Z (9 months ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 165 Last month
  • Rankings:
    • Stargazers count: 11.325%
    • Forks count: 12.823%
    • Dependent packages count: 29.797%
    • Average: 33.041%
    • Dependent repos count: 35.455%
    • Downloads: 75.804%
  • Maintainers (1)

Dependencies

DESCRIPTION cran
  • R >= 3.0.2 depends
  • tsibble >= 0.8.5 imports
  • devtools * suggests
  • knitr * suggests
  • lubridate * suggests
  • plotly * suggests
  • remotes * suggests
  • rmarkdown * suggests
  • testthat * suggests
  • tidyr * suggests
  • usethis * suggests

Score: 9.3886539073726