intensegRid

Provides information on national and regional carbon intensity, the amount of carbon emitted per unit of energy consumed, for the UK.
https://github.com/KKulma/intensegRid

Category: Emissions
Sub Category: Carbon Intensity and Accounting

Keywords

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

Keywords from Contributors

shiny

Last synced: about 20 hours ago
JSON representation

Repository metadata

R wrapper for National Grid Carbon Intensity API

README.Rmd

          ---
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!

        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 8 days ago

Total Commits: 79
Total Committers: 4
Avg Commits per committer: 19.75
Development Distribution Score (DDS): 0.468

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
kkulma k****a@m****m 42
kkulma k****a@g****m 30
Kasia Kulma k****a@e****m 6
Kasia Kulma k****a@M****l 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 11
Total pull requests: 25
Average time to close issues: about 2 months
Average time to close pull requests: about 15 hours
Total issue authors: 3
Total pull request authors: 2
Average comments per issue: 1.64
Average comments per pull request: 0.0
Merged pull request: 24
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/KKulma/intensegRid

Top Issue Authors

  • KKulma (9)
  • sckott (1)
  • dr-harper (1)

Top Pull Request Authors

  • KKulma (24)
  • dr-harper (1)

Top Issue Labels

  • enhancement (2)
  • good first issue (2)

Top Pull Request Labels


Package metadata

proxy.golang.org: github.com/kkulma/intensegrid

cran.r-project.org: intensegRid

R Wrapper for the Carbon Intensity API

  • Homepage: https://github.com/KKulma/intensegRid
  • Documentation: http://cran.r-project.org/web/packages/intensegRid/intensegRid.pdf
  • Licenses: CC0
  • Latest release: 0.1.2 (published over 2 years ago)
  • Last Synced: 2025-05-15T22:31:39.056Z (2 days ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 211 Last month
  • Rankings:
    • Forks count: 17.77%
    • Stargazers count: 17.865%
    • Dependent packages count: 29.797%
    • Average: 30.353%
    • Dependent repos count: 35.455%
    • Downloads: 50.879%
  • Maintainers (1)

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • dplyr * imports
  • httr * imports
  • jsonlite * imports
  • lubridate * imports
  • magrittr * imports
  • purrr * imports
  • rlang * imports
  • tibble * imports
  • tidyr * imports
  • covr * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 2.1.0 suggests
  • utils * suggests
  • vcr * suggests
.github/workflows/R-CMD-check-dev.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/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

Score: 9.381937965407161