From d3d607bc64c02e1827667bc93478b9ea645d4ef9 Mon Sep 17 00:00:00 2001 From: Kasia Date: Tue, 23 Mar 2021 22:26:07 +0000 Subject: [PATCH] update README --- .gitignore | 1 + README.md | 10 ++++++++-- ui.R | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 985cc5c..d5c17d5 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ carbon-intensity-app.Rproj rsconnect/ .DS_Store .Renviron +README.html diff --git a/README.md b/README.md index 94b62bd..495771a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ -# carbon-intensity-app +# How much electricity is made from renewable sources in UK? -link to the [app on shinyapps.io](https://kasiakulma.shinyapps.io/carbon-intensity-app/) +Our electricity is not made equal and can be associated with higher or lower carbon intensity. How much of UK's electricity is produced using renewable sources? Has it decreased or increased over time? [This Shiny app](https://kasiakulma.shinyapps.io/carbon-intensity-app/) will help answer these questions. + +The web app and the underlying data pipeline was built using open source tools. Web app's front-end was built using Shiny, electricity composition was extracted from National Grid's [Carbon Intensity API](https://carbonintensity.org.uk/) using [{intensegRid}](https://kkulma.github.io/intensegRid/articles/intro-to-carbon-intensity.html) package. Data and deployment pipelines were developed using GitHub Actions: `schedule.yml` pulls the carbon intensity data from the API, saves it in `data/daily_ci.rds` file daily and pushes the changes to the repo; `deploy.yml` deploys the changes to the [shinyapps.io server](https://kasiakulma.shinyapps.io/carbon-intensity-app/) on push. + + + + diff --git a/ui.R b/ui.R index 8e16f88..8f104cf 100644 --- a/ui.R +++ b/ui.R @@ -2,7 +2,7 @@ ui <- fluidPage( theme = my_theme, div( id = "header", - titlePanel(h1("How much UK energy is renewable?", align = "center")), + titlePanel(h1("How much UK electricity comes from renewable sources?", align = "center")), div( style = "display: inline-block; width: 250px;", span("View as heatmap", style = "font-size: large;"),