added summation check

[tscheypidi]

🐦 Description of this PR 🐦

added checkSummation output script for consistency checking of report.mif files.

🔧 Checklist for PR creator 🔧

• Label pull request from the label list.

  • Low risk: Simple bugfixes (missing files, updated documentation, typos) or changes in start or output scripts
  • Medium risk: Uncritical changes in the model core (e.g. moderate modifications in non-default realizations)
  • High risk: Critical changes in model core or default settings (e.g. changing a model default or adjusting a core mechanic in the model)

• Self-review own code

  • No hard coded numbers and cluster/country/region names.
  • The new code doesn't contain declared but unused parameters or variables.
  • magpie4 R library has been updated accordingly and backwards compatible where necessary.
  • scenario_config.csv has been updated accordingly (important if default.cfg has been updated)

• Document changes

  • Add changes to CHANGELOG.md
  • Where relevant, put In-code documentation comments
  • Properly address updates in interfaces in the module documentations
  • run goxygen::goxygen() and verify the modified code is properly documented

• Perform test runs

  • Low risk:
    • Run a compilation check via Rscript start.R --> "compilation check"
  • Medium risk:
    • Run test runs via Rscript start.R --> "test runs"
    • Check logs for errors/warnings
  • High risk:
    • Run test runs via Rscript start.R --> "test runs"
    • Check logs for errors/warnings
    • Default run from the PR target branch for comparison
    • Provide relevant comparison plots (land-use, emissions, food prices, land-use intensity,...)

📉 Performance changes 📈

• Current develop branch default : ** mins
• This PR's default : ** mins

🚨 Checklist for reviewer 🚨

• PR is labeled correctly
• Code changes look reasonable
  • No hard coded numbers and cluster/country/region names.
  • No unnecessary increase in module interfaces
  • model behavior/performance is satisfactory.
• Changes are properly documented
  • CHANGELOG is updated correctly
  • Updates in interfaces have been properly addressed in the module documentations
  • In-code documentation looks appropriate
• content review done (at least 1)
• RSE review done (at least 1)

[pascal-sauer]

Suggested change

	outputdir <-"."
	outputdir <- "."

[orichters]

Short comment:

Now, checkSummations() returns all summations, even those that are fine. But, I think that is stupid.

I will update the checkSummations function that already has a absDiff and relDiff parameter to return only the failing summation checks that are >= absDiff and >= relDiff.

For your case, I think it is advisable to select good thresholds (maybe absDiff = 0.001 as your mif has 4 digits and you want to avoid to be warned of rounding errors), or use absDiff = 0, relDiff = 0 if you really want everything.

And, potentially, you might make the writing of the file conditional on nrow(failvars) > 0. In REMIND, we execute this summation check automatically after every run, and even have a sumErr message in the mif column of the modeltests output to become informed, if that summation error file exists. That might be very easy for you to get as well.

[tscheypidi]

applied all requested changes and in addition added an abstract to citation.cff (required for PRISMA)

[jdrtommey]

All looks good to me