https://github.com/kkulma/intensegrid

R wrapper for National Grid Carbon Intensity API
https://github.com/kkulma/intensegrid

carbon-api carbon-emissions carbon-intensity climate-change hacktoberfest r

Last synced: about 2 months ago
JSON representation

R wrapper for National Grid Carbon Intensity API

• Host: GitHub
• URL: https://github.com/kkulma/intensegrid
• Owner: KKulma
• License: cc0-1.0
• Created: 2020-03-02T13:21:20.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-11-07T15:07:50.000Z (about 2 years ago)
• Last Synced: 2024-06-11T17:30:53.396Z (6 months ago)
• Topics: carbon-api, carbon-emissions, carbon-intensity, climate-change, hacktoberfest, r
• Language: R
• Homepage: https://carbonintensity.org.uk/
• Size: 228 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# About

[![R-CMD-check](https://github.com/KKulma/intensegRid/workflows/R-CMD-check/badge.svg)](https://github.com/KKulma/intensegRid/actions)

[![Codecov test coverage](https://codecov.io/gh/KKulma/intensegRid/branch/master/graph/badge.svg)](https://codecov.io/gh/KKulma/intensegRid?branch=master)

[![CRAN status](https://www.r-pkg.org/badges/version/intensegRid)](https://CRAN.R-project.org/package=intensegRid)

[![Downloads](http://cranlogs.r-pkg.org/badges/grand-total/intensegRid)](https://cran.r-project.org/package=intensegRid)

[![Downloads](http://cranlogs.r-pkg.org/badges/intensegRid)](https://cran.r-project.org/package=intensegRid)

# intensegRid 

This package is an API wrapper for [National Grid's Carbon Intensity API](https://carbonintensity.org.uk/). The API provides information on national and regional carbon intensity - the amount of carbon emitted per unit of energy consumed - for the UK. 

## Installation

Install the latest CRAN package with: 

```{r eval=FALSE}

install.packages("intensegRid")

```

Or you can install the development version from [GitHub](https://github.com/) with:

```{r eval=FALSE}

# install.packages("remotes")

remotes::install_github("KKulma/intensegRid")

```

## Examples

For examples on how to use **intensegRid** package refer to the [vignette](https://kkulma.github.io/intensegRid/articles/intro-to-carbon-intensity.html). 

## Limitations

In its current form, the package only accepts dates as `start` or `end` inputs (as Dates or character string), but not timestamps. However you can easily filter the output of **intensegRid** functions using [dplyr](https://dplyr.tidyverse.org/) and [lubridate](https://lubridate.tidyverse.org/) packages.

## Contribution

This is an open-source project and it welcomes your contribution! Feel free to use and test the package and if you find a bug, please, report it as [an issue](https://github.com/KKulma/intensegRid/issues). You may want to go even a step further and fix an issue you just raised!

If you're rather new to open source and git, [this repo](https://github.com/firstcontributions/first-contributions/blob/master/README.md) offers some easy to follow guidance on how to start. Thanks for your time and efforts!