add matchDim helper

.buildlibrary

@@ -1,4 +1,4 @@
-ValidationKey: '2246856528'
+ValidationKey: '2247009630'
 AcceptedWarnings:
 - 'Warning: package ''.*'' was built under R version'
 - 'Warning: namespace ''.*'' is not available and has been replaced'

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: 'remind2: The REMIND R package (2nd generation)'
-version: 1.135.12
-date-released: '2024-03-12'
+version: 1.135.14
+date-released: '2024-03-13'
 abstract: Contains the REMIND-specific routines for data and model output manipulation.
 authors:
 - family-names: Rodrigues

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: remind2
 Title: The REMIND R package (2nd generation)
-Version: 1.135.12
-Date: 2024-03-12
+Version: 1.135.14
+Date: 2024-03-13
 Authors@R: c(
     person("Renato", "Rodrigues", , "renato.rodrigues@pik-potsdam.de", role = c("aut", "cre")),
     person("Lavinia", "Baumstark", role = "aut"),

NAMESPACE

@@ -28,6 +28,7 @@ export(getRunsMIFGDX)
 export(get_total_efficiencies)
 export(loadCs2Data)
 export(loadModeltest)
+export(matchDim)
 export(nashAnalysis)
 export(plotCDR)
 export(plotLCOE)

R/matchDim.R

@@ -0,0 +1,29 @@
+#' match object dimensions of a magclass object
+#'
+#' A helper that restricts and expands a magclass object x to the size of a
+#' magclass object ref.
+#'
+#' @param x a magclass object to be modified
+#' @param ref a magclass object used as a reference for the modification
+#' @param fill value to be set in new dimensions
+#'
+#' @export
+matchDim <- function(x, ref, fill = 0) {
+
+  # extend the object to the union of both objects
+  r <- new.magpie(
+    cells_and_regions = union(getRegions(x), getRegions(ref)),
+    years = union(getYears(x), getYears(ref)),
+    names = union(getNames(x), getNames(ref)),
+    fill = fill,
+    sets = names(dimnames(ref))
+  )
+
+  # copy over values from x
+  r[getRegions(x), getYears(x), getNames(x)] <- x
+
+  # restrict object to dimensions of ref
+  r <- r[getRegions(ref), getYears(ref), getNames(ref)]
+
+  return(r)
+}

R/reportEmi.R

@@ -143,8 +143,11 @@ reportEmi <- function(gdx, output = NULL, regionSubsetList = NULL,
   # FE non-energy use
   vm_demFENonEnergySector <- readGDX(gdx, "vm_demFENonEnergySector", field = "l",
                                      restore_zeros = F, react = "silent")[,t,]
+
   if (length(vm_demFENonEnergySector) == 0) {
     vm_demFENonEnergySector <- NULL
+  } else {
+    vm_demFENonEnergySector <- matchDim(vm_demFENonEnergySector, vm_demFeSector)
   }
 
   # secondary energy production
@@ -301,7 +304,7 @@ reportEmi <- function(gdx, output = NULL, regionSubsetList = NULL,
 
     # calculate FE without non-energy use
     vm_demFeSector_woNonEn <- vm_demFeSector
-    vm_demFeSector_woNonEn[,,getNames(vm_demFENonEnergySector )] <- vm_demFeSector[,,getNames(vm_demFENonEnergySector )]-vm_demFENonEnergySector
+    vm_demFeSector_woNonEn[,,getNames(vm_demFENonEnergySector )] <- vm_demFeSector[,,getNames(vm_demFENonEnergySector)] - vm_demFENonEnergySector
   }
 
   # Read-in plastic-related variables

README.md

@@ -1,6 +1,6 @@
 # The REMIND R package (2nd generation)
 
-R package **remind2**, version **1.135.12**
+R package **remind2**, version **1.135.14**
 
 [![CRAN status](https://www.r-pkg.org/badges/version/remind2)](https://cran.r-project.org/package=remind2)  [![R build status](https://github.com/pik-piam/remind2/workflows/check/badge.svg)](https://github.com/pik-piam/remind2/actions) [![codecov](https://codecov.io/gh/pik-piam/remind2/branch/master/graph/badge.svg)](https://app.codecov.io/gh/pik-piam/remind2) [![r-universe](https://pik-piam.r-universe.dev/badges/remind2)](https://pik-piam.r-universe.dev/builds)
 
@@ -49,7 +49,7 @@ In case of questions / problems please contact Renato Rodrigues <renato.rodrigue
 
 To cite package **remind2** in publications use:
 
-Rodrigues R, Baumstark L, Benke F, Dietrich J, Dirnaichner A, Duerrwaechter J, Führlich P, Giannousakis A, Hasse R, Hilaire J, Klein D, Koch J, Kowalczyk K, Levesque A, Malik A, Merfort A, Merfort L, Morena-Leiva S, Pehl M, Pietzcker R, Rauner S, Richters O, Rottoli M, Schötz C, Schreyer F, Siala K, Sörgel B, Spahr M, Strefler J, Verpoort P, Weigmann P (2024). _remind2: The REMIND R package (2nd generation)_. R package version 1.135.12, <https://github.com/pik-piam/remind2>.
+Rodrigues R, Baumstark L, Benke F, Dietrich J, Dirnaichner A, Duerrwaechter J, Führlich P, Giannousakis A, Hasse R, Hilaire J, Klein D, Koch J, Kowalczyk K, Levesque A, Malik A, Merfort A, Merfort L, Morena-Leiva S, Pehl M, Pietzcker R, Rauner S, Richters O, Rottoli M, Schötz C, Schreyer F, Siala K, Sörgel B, Spahr M, Strefler J, Verpoort P, Weigmann P (2024). _remind2: The REMIND R package (2nd generation)_. R package version 1.135.14, <https://github.com/pik-piam/remind2>.
 
 A BibTeX entry for LaTeX users is
 
@@ -58,7 +58,7 @@ A BibTeX entry for LaTeX users is
   title = {remind2: The REMIND R package (2nd generation)},
   author = {Renato Rodrigues and Lavinia Baumstark and Falk Benke and Jan Philipp Dietrich and Alois Dirnaichner and Jakob Duerrwaechter and Pascal Führlich and Anastasis Giannousakis and Robin Hasse and Jérome Hilaire and David Klein and Johannes Koch and Katarzyna Kowalczyk and Antoine Levesque and Aman Malik and Anne Merfort and Leon Merfort and Simón Morena-Leiva and Michaja Pehl and Robert Pietzcker and Sebastian Rauner and Oliver Richters and Marianna Rottoli and Christof Schötz and Felix Schreyer and Kais Siala and Björn Sörgel and Mike Spahr and Jessica Strefler and Philipp Verpoort and Pascal Weigmann},
   year = {2024},
-  note = {R package version 1.135.12},
+  note = {R package version 1.135.14},
   url = {https://github.com/pik-piam/remind2},
 }
 ```

tests/testthat/test-matchDim.R

@@ -0,0 +1,38 @@
+test_that("matchDim works", {
+  region <- c("AAA", "BBB", "CCC")
+  t <- paste0("y", c(2000, 2005, 2010))
+  name <- c("foo", "bar", "bazz")
+
+  A <- new.magpie(
+    cells_and_regions = region, years = t, names = name, fill = 1,
+    sets = c("region", "t", "name")
+  )
+
+  # spatial ----
+  ## x smaller then ref ----
+  expect_equal(matchDim(A[region[-2],,], A),
+               `mselect<-`(A, region = region[2], value = 0))
+
+  ## x larger then ref ----
+  expect_equal(matchDim(A, A[region[-2],,]),
+               A[region[-2],,])
+
+  # temporal ----
+  ## x smaller then ref ----
+  expect_equal(matchDim(A[,t[-2],], A),
+               `mselect<-`(A, t = t[2], value = 0))
+
+  ## x larger then ref ----
+  expect_equal(matchDim(x = A, ref = A[,t[-2],]),
+               A[,t[-2],])
+
+  # names ----
+  ## x smaller then ref ----
+  expect_equal(matchDim(A[,,name[-2]], A),
+               `mselect<-`(A, name = name[2], value = 0))
+
+  ## x larger then ref ----
+  expect_equal(matchDim(A, A[,,name[-2]]),
+               A[,,name[-2]])
+
+})