Initial compare scenarios

.buildlibrary

@@ -1,8 +1,8 @@
-ValidationKey: '218185'
+ValidationKey: '397020'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'
 - 'Warning: namespace ''.*'' is not available and has been replaced'
-AcceptedNotes: ~
+AcceptedNotes: Namespaces in Imports field not imported from\:\n *.mip. .piamPlotComparison.
 allowLinterWarnings: no
 enforceVersionUpdate: no

.gitignore

@@ -2,3 +2,5 @@
 .Rhistory
 .RData
 .Ruserdata
+*.pdf
+*_Rmd/*

.pre-commit-config.yaml

@@ -3,7 +3,7 @@
 exclude: '^tests/testthat/_snaps/.*$'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c  # frozen: v4.6.0
     hooks:
     -   id: check-case-conflict
     -   id: check-json
@@ -15,7 +15,7 @@ repos:
     -   id: mixed-line-ending
 
 -   repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.4.0
+    rev: 7910e0323d7213f34275a7a562b9ef0fde8ce1b9  # frozen: v0.4.2
     hooks:
     -   id: parsable-R
     -   id: deps-in-desc

CITATION.cff

@@ -2,8 +2,8 @@ cff-version: 1.2.0
 message: If you use this software, please cite it using the metadata from this file.
 type: software
 title: 'reportbrick: Reporting package for BRICK'
-version: 0.1.1
-date-released: '2024-04-22'
+version: 0.2.0
+date-released: '2024-05-08'
 abstract: This package contains BRICK-specific routines to report model results. The
   main functionality is to generate a mif-file from a given BRICK model run folder.
 authors:

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: reportbrick
 Title: Reporting package for BRICK
-Version: 0.1.1
-Date: 2024-04-22
+Version: 0.2.0
+Date: 2024-05-08
 Authors@R:
     person("Robin", "Hasse", , "[email protected]",
            role = c("aut", "cre"),
@@ -15,6 +15,8 @@ Imports:
   gamstransfer (>= 3.0.1),
   madrat,
   magclass,
+  mip (>= 0.148.15),
+  piamPlotComparison,
   yaml
 Suggests:
     covr,

README.md

@@ -1,8 +1,8 @@
 # Reporting package for BRICK
 
-R package **reportbrick**, version **0.1.1**
+R package **reportbrick**, version **0.2.0**
 
-[![CRAN status](https://www.r-pkg.org/badges/version/reportbrick)](https://cran.r-project.org/package=reportbrick)  [![R build status](https://github.com/pik-piam/reportbrick/workflows/check/badge.svg)](https://github.com/pik-piam/reportbrick/actions) [![codecov](https://codecov.io/gh/pik-piam/reportbrick/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/reportbrick) 
+[![CRAN status](https://www.r-pkg.org/badges/version/reportbrick)](https://cran.r-project.org/package=reportbrick)  [![R build status](https://github.com/pik-piam/reportbrick/workflows/check/badge.svg)](https://github.com/pik-piam/reportbrick/actions) [![codecov](https://codecov.io/gh/pik-piam/reportbrick/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/reportbrick) [![r-universe](https://pik-piam.r-universe.dev/badges/reportbrick)](https://pik-piam.r-universe.dev/builds)
 
 ## Purpose and Functionality
 
@@ -38,7 +38,7 @@ In case of questions / problems please contact Robin Hasse <robin.hasse@pik-pots
 
 To cite package **reportbrick** in publications use:
 
-Hasse R (2024). _reportbrick: Reporting package for BRICK_. R package version 0.1.1, <https://github.com/pik-piam/reportbrick>.
+Hasse R (2024). _reportbrick: Reporting package for BRICK_. R package version 0.2.0, <https://github.com/pik-piam/reportbrick>.
 
 A BibTeX entry for LaTeX users is
 
@@ -47,7 +47,7 @@ A BibTeX entry for LaTeX users is
   title = {reportbrick: Reporting package for BRICK},
   author = {Robin Hasse},
   year = {2024},
-  note = {R package version 0.1.1},
+  note = {R package version 0.2.0},
   url = {https://github.com/pik-piam/reportbrick},
 }
 ```

inst/compareScenarios/cs_01_stocks_flows.Rmd

@@ -0,0 +1,49 @@
+# Stock and flows
+
+## Building stock
+
+```{r stock vars}
+tot <- "Stock|Buildings"
+subsec <- c("Stock|Residential",
+            "Stock|Commercial")
+```
+
+```{r StockSubsector}
+showAreaAndBarPlots(data, vars = subsec, tot = tot, orderVars = "user", scales = "fixed")
+```
+
+### All buildings
+
+### Residential
+```{r residential stock vars}
+tot <- "Stock|Residential"
+heatingRes <- paste(tot, heating, sep = "|")
+vintageRes <- paste(tot, vintage, sep = "|")
+typeRes <- paste(tot, type, sep = "|")
+locationRes <- paste(tot, location, sep = "|")
+```
+
+#### by building type
+```{r Stock-Residential-(type)}
+showAreaAndBarPlots(data, vars = typeRes, tot = tot, orderVars = "user", scales = "fixed")
+walk(typeRes, showLinePlots, data = data)
+```
+
+#### by location
+```{r Stock-Residential-(location)}
+showAreaAndBarPlots(data, vars = locationRes, tot = tot, orderVars = "user", scales = "fixed")
+walk(locationRes, showLinePlots, data = data)
+```
+
+#### by construction cohort
+```{r Stock-Residential-(vintage)}
+showAreaAndBarPlots(data, vars = rev(vintageRes), tot = tot, orderVars = "user", scales = "fixed")
+```
+
+#### by Space heating
+```{r Stock-Residential-(heating)}
+showAreaAndBarPlots(data, vars = heatingRes, tot = tot, orderVars = "user", scales = "fixed")
+walk(heatingRes, showLinePlots, data = data)
+```
+
+### Commercial

inst/compareScenarios/preprocessing.R

@@ -0,0 +1,41 @@
+# Load additional libraries ----------------------------------------------------
+
+library(dplyr) # nolint: undesirable_function_linter.
+
+
+
+# BRICK sets -------------------------------------------------------------------
+
+# Sets are used in Rmd files to select variables
+
+subsec <- c(
+  "Residential",
+  "Commercial"
+)
+type <- c(
+  "SFH",
+  "MFH"
+)
+location <- c(
+  "Urban",
+  "Rural"
+)
+heating <- c(
+  "Biomass",
+  "District heating",
+  "Heat pump",
+  "Resistive electric",
+  "Gas",
+  "Liquids",
+  "Coal"
+)
+
+# automatic identification of vintages to allow for different model resolutions
+vintageRegex <- "(Before|After) \\d{4}|\\d{4} - \\d{4}"
+vintage <- grep(vintageRegex, unique(data[["variable"]]), value = TRUE) %>%
+  unique() %>%
+  sub(pattern = paste0("^.*(", vintageRegex, ").*$"), replacement = "\\1") %>%
+  unique()
+vintage <- c(grep("^Before", vintage, value = TRUE),
+             sort(grep("^\\d{4}", vintage, value = TRUE)),
+             grep("^After", vintage, value = TRUE))