Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add output report to validate spatial patterns in EU countries #680

Merged
merged 8 commits into from
Jun 21, 2024

Conversation

DavidhoPIK
Copy link
Contributor

@DavidhoPIK DavidhoPIK commented May 27, 2024

🐦 Description of this PR 🐦

This PR adds an output report to validate EU spatial pattern against LUH2v2 data. It uses rmarkdown to output an interactive html document.
See some screenshots of an example output here:
image

image

and a full example output here.
(sometimes a reload after a minute or so is required on my PC for correct display of content)

🔧 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)

@DavidhoPIK DavidhoPIK added the Low risk Low risk label May 27, 2024
@DavidhoPIK DavidhoPIK changed the base branch from master to develop May 27, 2024 12:46
@DavidhoPIK DavidhoPIK changed the title Add eu output report Add output report for spatial patterns in the EU May 27, 2024
@DavidhoPIK DavidhoPIK changed the title Add output report for spatial patterns in the EU add output report for spatial patterns of EU regions May 27, 2024
@DavidhoPIK DavidhoPIK changed the title add output report for spatial patterns of EU regions add output report to validate spatial patterns in EU countries May 27, 2024
@DavidhoPIK DavidhoPIK added the enhancement New feature or request label May 27, 2024
@DavidhoPIK DavidhoPIK requested review from mishkos and jdrtommey May 28, 2024 09:46
@DavidhoPIK DavidhoPIK marked this pull request as ready for review May 28, 2024 09:46
Copy link
Contributor

@mishkos mishkos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all good.

@DavidhoPIK DavidhoPIK force-pushed the add_EU_output_report branch from 0f38159 to 773ace4 Compare June 21, 2024 08:55
@DavidhoPIK DavidhoPIK merged commit c3f649f into magpiemodel:develop Jun 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Low risk Low risk
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants