Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
KKulma committed Mar 23, 2021
1 parent 00d03fe commit d3d607b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ carbon-intensity-app.Rproj
rsconnect/
.DS_Store
.Renviron
README.html
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.




2 changes: 1 addition & 1 deletion ui.R
Original file line number Diff line number Diff line change
Expand Up @@ -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;"),
Expand Down

0 comments on commit d3d607b

Please sign in to comment.