ieatools

Tools for munging and manipulating IEA extended energy balance data.

https://github.com/matthewheun/ieatools

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Tools for munging and manipulating IEA extended energy balance data.

Basic Info
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 73
Created almost 7 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.Rmd

---
output: github_document
bibliography: vignettes/References.bib
---



[![CRAN status](https://www.r-pkg.org/badges/version/IEATools)](https://cran.r-project.org/package=IEATools)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
[![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/#active)
[![R-CMD-check](https://github.com/MatthewHeun/IEATools/workflows/R-CMD-check/badge.svg)](https://github.com/MatthewHeun/IEATools/actions)
[![Codecov test coverage](https://codecov.io/gh/MatthewHeun/IEATools/branch/master/graph/badge.svg)](https://codecov.io/gh/MatthewHeun/IEATools?branch=master)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5086371.svg)](https://doi.org/10.5281/zenodo.5086371)


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


# IEATools


## Statement of need

Extended World Energy Balance (EWEB) data from the
[International Energy Agency (IEA)](http://www.iea.org) (IEA) 
are indispensable for societal energy analysis and
societal exergy analysis (SEA).
However, 

* the EWEB data are not available native in the `R` data frame format;
* as distributed, the EWEB data are definitely not 
  [tidy](http://vita.had.co.nz/papers/tidy-data.pdf); and 
* the EWEB are not in physical supply-use table (PSUT) format
  proposed by [@Heun:2018](https://doi.org/10.1016/j.apenergy.2018.05.109).

`IEATools` provides functions to address the above needs.


## Installation


You can install `IEATools` from GitHub with:

```{r gh-installation, eval = FALSE}
# install devtools if not already installed
# install.packages("devtools")
devtools::install_github("MatthewHeun/IEATools")
# To build vignettes locally, use
devtools::install_github("MatthewHeun/IEATools", build_vignettes = TRUE)
```


## History

The functions in this package were used in 
[Heun et al. [-@Heun:2018]](https://doi.org/10.1016/j.apenergy.2018.05.109).

Permission to distribute IEA extended energy balance data
for two years and two countries was obtained 
by Matthew Kuperus Heun from Nick Johnstone of the IEA
during a phone call at 11 AM on Mon, 3 June 2019.


## More Information

Find more information, including vignettes and function documentation, at 
.




## References

Owner

  • Login: MatthewHeun
  • Kind: user

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: IEATools
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Matthew
    family-names: Heun
    email: matthew.heun@me.com
    affiliation: Calvin University
    orcid: 'https://orcid.org/0000-0002-7438-214X'
  - given-names: Emmanuel
    family-names: Aramendia
    email: e.aramendia@leeds.ac.uk
    affiliation: University of Leeds
    orcid: 'https://orcid.org/0000-0002-5964-6776'
  - given-names: Zeke
    family-names: Marshall
    email: Z.Marshall@leeds.ac.uk
    affiliation: University of Leeds
    orcid: 'https://orcid.org/0000-0001-9260-7827'
identifiers:
  - type: doi
    value: 10.5281/zenodo.5086371
    description: DOI for all versions of the package
repository-code: 'https://github.com/MatthewHeun/IEATools'
url: 'https://matthewheun.github.io/IEATools/'
abstract: >-
  Tools for munging and manipulating International Energy Agency extended energy.
license: MIT

GitHub Events

Total
  • Release event: 3
  • Delete event: 6
  • Push event: 74
  • Create event: 10
Last Year
  • Release event: 3
  • Delete event: 6
  • Push event: 74
  • Create event: 10

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • Hmisc * imports
  • RCLabels * imports
  • assertthat * imports
  • countrycode * imports
  • data.table * imports
  • dplyr * imports
  • glue * imports
  • magrittr * imports
  • matsbyname * imports
  • matsindf * imports
  • openxlsx * imports
  • purrr * imports
  • readxl * imports
  • rlang * imports
  • stringi * imports
  • stringr * imports
  • tibble * imports
  • tidyr * imports
  • tidyselect * imports
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • spelling * suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/upload-artifact main composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/test-coverage.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite