knitr::opts_chunk$set(
  fig.height=5, fig.width=8, 
  message=FALSE, warning=FALSE,
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%")

USgas

CRAN_Status_Badge lifecycle License: MIT GitHub commit

The USgas package provides an overview of demand for natural gas in the US in a time-series format. That includes the following dataset:

The package also includes the following datasets, from previous release:

The us_total, us_monthly, and us_residential can be derived out of the usgas dataset. Therefore, those datasets in the process of deprication and will be removed in the next release to CRAN.

Data source: The US Energy Information Administration API

More information about the package datasets available on this vignette.

Installation

You can install the released version of USgas from CRAN with:

install.packages("USgas")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("RamiKrispin/USgas")

Example

Let's load the data:

data("usgas")

head(usgas)

str(usgas)

Plotting the residential consumption of natural gas in the US:

library(plotly)

us_res <- usgas[which(usgas$state == "U.S." & usgas$process == "Residential Consumption"), ]

plot_ly(data = us_res,
        x = ~ date,
        y = ~ y,
        type = "scatter",
        mode = "line") |>
  layout(title = "US Monthly Residential Consumption",
         yaxis = list(title = "MMCF"),
         xaxis = list(title = "Source: EIA API"))
library(plotly)

us_res <- usgas[which(usgas$state == "U.S." & usgas$process == "Residential Consumption"), ]

p1 <- plot_ly(data = us_res,
        x = ~ date,
        y = ~ y,
        type = "scatter",
        mode = "line") |>
  layout(title = "US Monthly Natural Gas Consumption by Residential Consumers",
         yaxis = list(title = "MMCF"),
         xaxis = list(title = "Source: EIA API"))
orca(p1, "man/figures/us_res.svg")

Plotting the total monthly natural gas delivered in the New England states:

ne <- c("Connecticut", "Maine", "Massachusetts",
        "New Hampshire", "Rhode Island", "Vermont")
ne_gas <-  usgas[which(usgas$state %in% ne & usgas$process == "Delivered to Consumers"),]

plot_ly(data = ne_gas,
        x = ~ date,
        y = ~ y,
        color = ~ state,
        type = "scatter",
        mode = "line") |>
  layout(title = "Total Natrual Gas Delivered to Consumers in New England States",
         yaxis = list(title = "MMCF"),
         xaxis = list(title = "Source: EIA API"))
ne <- c("Connecticut", "Maine", "Massachusetts",
        "New Hampshire", "Rhode Island", "Vermont")
ne_gas <-  usgas[which(usgas$state %in% ne & usgas$process == "Delivered to Consumers"),]

p2 <- plot_ly(data = ne_gas,
        x = ~ date,
        y = ~ y,
        color = ~ state,
        type = "scatter",
        mode = "line") |>
  layout(title = "Total Natrual Gas Delivered to Consumers in New England States",
         yaxis = list(title = "MMCF"),
         xaxis = list(title = "Source: EIA API"))

orca(p2, "man/figures/new_england.svg")



RamiKrispin/USgas documentation built on April 26, 2023, 12:22 p.m.