recca

Use R for Energy Conversion Chain analysis

https://github.com/matthewheun/recca

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 (16.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Use R for Energy Conversion Chain analysis

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

README.Rmd

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






[![CRAN status](https://www.r-pkg.org/badges/version/Recca)](https://cran.r-project.org/package=Recca)
[![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/Recca/workflows/R-CMD-check/badge.svg)](https://github.com/MatthewHeun/Recca/actions)
[![Codecov test coverage](https://codecov.io/gh/MatthewHeun/Recca/graph/badge.svg)](https://app.codecov.io/gh/MatthewHeun/Recca)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5226085.svg)](https://doi.org/10.5281/zenodo.5226085)

# Recca


## Statement of Need

Societal energy analysis and societal exergy analysis (SEA)
make extensive use of the energy conversion chain (ECC), 
a description of energy flows through society 
from the primary stage 
(resources extracted from the environment, 
such as coal, oil, natural gas, wind, and solar),
to the final stage
(energy purchased by consumers, 
such as refined petroleum and electricity),
to the useful stage
(energy desired by the end user, 
such as heat, motion, and light),
and sometimes to energy services
(such as thermal comfort, transport, and illumination).
Such analyses are significantly easier 
when data are arranged in the 
**R**, **U**, **V**, and **Y** matrices
of the PSUT framework described by 
[Heun et al.
[-@Heun:2018]](https://doi.org/10.1016/j.apenergy.2018.05.109).

To facilitate SEA with the PSUT framework,
computational tools are needed.
The computational tools should be amenable to 
use with [matsindf](https://MatthewHeun.github.io/matsindf/)
data frames of ECC matrices
and written with plain names for functions and data..
The `Recca` package provides 
such computational tools.


## Installation

You can install `Recca` from github with:

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


## History

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


## 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: Recca
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'
identifiers:
  - type: doi
    value: 10.5281/zenodo.5226085
    description: DOI for all versions of the package
repository-code: 'https://github.com/MatthewHeun/Recca'
url: 'https://matthewheun.github.io/Recca/'
abstract: >-
  Provides functions to analyze energy conversion chains
  using a physical supply use table (PSUT) approach.
license: MIT

GitHub Events

Total
  • Release event: 4
  • Delete event: 5
  • Push event: 87
  • Create event: 8
Last Year
  • Release event: 4
  • Delete event: 5
  • Push event: 87
  • Create event: 8

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • Hmisc * imports
  • RCLabels * imports
  • assertthat * imports
  • dplyr * imports
  • fuzzyjoin * imports
  • lazyeval * imports
  • magrittr * imports
  • matsbyname * imports
  • matsindf * imports
  • networkD3 * imports
  • parallel * imports
  • purrr * imports
  • rlang * imports
  • tibble * imports
  • tidyr * imports
  • IEATools * suggests
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • spelling * suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite