Check if reporting Set fits gdx #6
Conversation
There was a problem hiding this comment.
Thank you for this feature, I hope this will be very helpful for debugging in the future.
If I'm not mistaken, this implementation would not directly catch the case I stumbled upon in the past and only give a warning (see inline comment). I would prefer this to be an error as well, as long as we believe that it will always fail further below.
R/convGDX2MIF.R
Outdated
| warning("The following set elements are mapped in the reporting template ", | ||
| "but not found in the gdx:\n ", | ||
| paste(capture.output(setElements[["surplus"]]), collapse = "\n ")) | ||
| } |
There was a problem hiding this comment.
I was wondering if this case should also throw an error? The case I had that confused me was this one, i.e. more set elements in the template than in the gdx. I haven't checked though if this will always lead to an error below and of course already the warning would help a lot with the debugging.
I tried to check whether some of your other changes might actually prevent this case from failing, but I don't think so.
There was a problem hiding this comment.
Your are right, I was too lazy. In the reporting template, bs and hs are no longer defined as aliases of bsr and hsr respectively but as childs. As such, they can contain less elements and subsets than their parent set. This allows to make the test for inconsistencies more stringent. Any inconsistency (missing or surplus elements) between reporting template and gdx (missing or surplus elements) will lead to an error now.
R/convGDX2MIF.R
Outdated
| @@ -27,6 +35,11 @@ convGDX2MIF <- function(gdx, tmpl = NULL, file = NULL, scenario = "default", t = | |||
| } | |||
|
|
|||
| brickSets <- readBrickSets(tmpl) | |||
| inconsistencies <- .findInconsistenSetElements(brickSets, gdx) | |||
| if (!is.null(inconsistencies)) { | |||
| stop("The reporting template is not consisten with the gdx:\n ", | |||
There was a problem hiding this comment.
| stop("The reporting template is not consisten with the gdx:\n ", | |
| stop("The reporting template is not consistent with the gdx:\n ", |
Spelling error
There was a problem hiding this comment.
Thanks for spotting. I corrected that.
The reporting template is now checked for consistency with the gdx. Surplus set elements trigger a warning and missing elements an error. This should help the user when selecting a reporting template that doesn't fit the run.
As bs and hs are currently just copies of bsr and hsr respectively, you always get a warning for the 0 elements. Not sure if we should change that such that or live with an expected warning. I could either implement an exception for the warning or the creation of aliases in the mapping.