Handle missing periods from report functions

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '1400280'
+ValidationKey: '1420426'
 AutocreateReadme: yes
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'

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.7.0
-date-released: '2024-10-08'
+version: 0.7.1
+date-released: '2024-10-10'
 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.7.0
-Date: 2024-10-08
+Version: 0.7.1
+Date: 2024-10-10
 Authors@R: c(
     person("Robin", "Hasse", , "robin.hasse@pik-potsdam.de",
            role = c("aut", "cre"),

NAMESPACE

@@ -34,9 +34,11 @@ importFrom(magclass,dimSums)
 importFrom(magclass,getItems)
 importFrom(magclass,getNames)
 importFrom(magclass,getSets)
+importFrom(magclass,getYears)
 importFrom(magclass,mbind)
 importFrom(magclass,mselect)
 importFrom(magclass,ndim)
+importFrom(magclass,new.magpie)
 importFrom(magclass,setNames)
 importFrom(magclass,write.report)
 importFrom(piamutils,getSystemFile)

R/convGDX2MIF.R

@@ -50,23 +50,23 @@ convGDX2MIF <- function(gdx,
 
   ## Stock ====
   message("running reportBuildingStock ...")
-  output <- mbind(output, reportBuildingStock(gdx, brickSets, silent = silent)[, t, ])
+  output <- mbind(output, extendPeriods(reportBuildingStock(gdx, brickSets, silent = silent), t))
 
   ## Construction ====
   message("running reportConstruction ...")
-  output <- mbind(output, reportConstruction(gdx, brickSets, silent = silent)[, t, ])
+  output <- mbind(output, extendPeriods(reportConstruction(gdx, brickSets, silent = silent), t))
 
   ## Renovation ====
   message("running reportRenovation ...")
-  output <- mbind(output, reportRenovation(gdx, brickSets, silent = silent)[, t, ])
+  output <- mbind(output, extendPeriods(reportRenovation(gdx, brickSets, silent = silent), t))
 
   ## Demolition ====
   message("running reportDemolition ...")
-  output <- mbind(output, reportDemolition(gdx, brickSets, silent = silent)[, t, ])
+  output <- mbind(output, extendPeriods(reportDemolition(gdx, brickSets, silent = silent), t))
 
   ## Energy ====
   message("running reportEnergy ...")
-  output <- mbind(output, reportEnergy(gdx, brickSets, silent = silent)[, t, ])
+  output <- mbind(output, extendPeriods(reportEnergy(gdx, brickSets, silent = silent), t))
 
 
   # FINISH ---------------------------------------------------------------------

R/extendPeriods.R

@@ -0,0 +1,19 @@
+#' Crop MagPIE object to given periods and fill missing periods
+#'
+#' @param x MagPIE object
+#' @param periods numeric vector with target periods
+#' @param fill value to fill missing period values
+#' @returns MagPIE object with given periods in temporal dimension
+#'
+#' @author Robin Hasse
+#'
+#' @importFrom magclass getYears new.magpie getItems getNames
+
+extendPeriods <- function(x, periods, fill = NA) {
+  r <- getItems(x, dim = 1)
+  n <- getNames(x)
+  t <- intersect(getYears(x, as.integer = TRUE), periods)
+  out <- new.magpie(cells_and_regions = r, years = periods, names = n, fill = fill)
+  out[r, t, ] <- x[r, t, ]
+  return(out)
+}

README.md

@@ -1,6 +1,6 @@
 # Reporting package for BRICK
 
-R package **reportbrick**, version **0.7.0**
+R package **reportbrick**, version **0.7.1**
 
 [![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)
 
@@ -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, Rosemann R (2024). _reportbrick: Reporting package for BRICK_. R package version 0.7.0, <https://github.com/pik-piam/reportbrick>.
+Hasse R, Rosemann R (2024). _reportbrick: Reporting package for BRICK_. R package version 0.7.1, <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 and Ricarda Rosemann},
   year = {2024},
-  note = {R package version 0.7.0},
+  note = {R package version 0.7.1},
   url = {https://github.com/pik-piam/reportbrick},
 }
 ```