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

CRAN status lifecycle Project Status: Active – The project has reached a stable, usable state and is being actively developed. Codecov test coverage DOI R-CMD-check

EROITools

The R package EROITools provides tools to aggregate Energy Return On Investment (EROI) values previously calculated using a Physical Supply Use Table (PSUT) framework to represent the Energy Conversion Chain (see @Heun:2018). Previous to using the EROITools package, the World Energy Extended Balances (WEEB) from the International Energy Agency (IEA) can be loaded and tidied using the IEATools and ECCTools R packages. The Recca R package then allows analysts to calculate a wide range of EROIs at the product and industry levels, and the EROITools package provides tools aggregate the calculated EROIs by product group. Important features of the EROITools package include the following:

Installation

You can install EROITools from github with:

# install devtools if not already installed
# install.packages("devtools")
devtools::install_github("earamendia/EROITools")
# To build vignettes locally, use
devtools::install_github("earamendia/EROITools", build_vignettes = TRUE)

History

This package builds upon the previous IEATools, Recca, and ECCTools R packages and will be demonstrated in a paper as soon as possible. The calculations conducted within the package are heavily dependent on the Physical Supply Use Table framework introduced to represent the Energy Conversion Chain in @Heun:2018 and further developed in @mr_psut_paper.

More Information

Find more information, including vignettes and function documentation, at https://earamendia.github.io/EROITools/.

References



earamendia/EROITools documentation built on May 19, 2023, 10:30 a.m.