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

Refactor and change default scenarios #89

Merged
merged 3 commits into from
Nov 6, 2024

Conversation

johanneskoch94
Copy link
Member

@johanneskoch94 johanneskoch94 commented Oct 1, 2024

  • Replace SSP2EU with a placeholder, as it no longer a desired scenario, but required in the input preparation pipeline. Remove completely in next release.
  • Add ADB sources and scenarios (not returned by default yet).
  • Urban pop share scenarios are improved, so as to never exceed 1, even with bezier extensions.
  • SSP labour scenarios are now also filled in with UN_popDiv data.
  • SSP population scenarios now use short term growth rates from PEAP-UN_PopDiv, instead of PEAP-MI, improving the short-term projections of the smaller countries.
  • Refactor function arguments that did not comply with lintr rules (fixes Refactor old function arguments, that don't comply with the object_name_lintr = camelCase  #13).
  • Mark "scenario.indicator" naming option as deprecated and remove in next release.
  • Fix all linter warnings.
  • Improve scenario documentation and references in vignette (fixes No citable source for GDP data. #56 and fixes Insufficient citable sources for Population data. #57).
  • Improve and simplify documentation (fixes Improve documentation of functions #16).
  • Remove "unit" from most functions, assuming instead that the default dollar unit is used throughout the package.
  • Clean up use of James data set for filling and backwards extension to 1960. These two functions are now cleanly separated from each other. Also, use of the James2019 dataset is dropped (fixes Combine readJames and readJames2019 into single source #62), due to the fact that there is no reference for this dataset. This does not affect the scenarios much since the dataset is mainly used for its growth rates, and they shouldn't differ to much.
  • Refactor toolReduce and toolFillWith. toolFillWith now writes to the log which countries are filled in.
  • Export some of the more useful tool functions.
  • Speed up bezier extension (fixes Speed up #78).
  • Remove MI from future datasets and make it clear that we assume constant extrapolation for most of the MI countries.
  • Fixes ATG and LIE GDPpc trajectories #52.
  • Fixes 2005 → 2017 conversion missing for per-capita GDP figures in James and James2019 #91
  • Add warnings when converting to non-default base-year units (the current base year being 2017). These conversions (within calcGDP and caldGDPpc) use only the US deflator for all countries, and neglect any changes in PPPs or MERs. Standard conversion would not guarantee that relationships between countries (an important charateristic of the scenario design) remain same.
  • Make choice of graphics device explicit when computing the bezier extensions (fixes Inconsistency between local machine and cluster #79).

@johanneskoch94
Copy link
Member Author

Hey @0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q. I would like to close issues #56 and #57 with this PR. Would you take a look and let me know if you agree? The references are here, and this vignette is linked to in the descriptions of the calc functions, and also available on the website.

@0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q
Copy link
Member

Nice. Personally, I would prefer a link to the Zenodo DOI instead of a direct download link where possible (i.e. https://doi.org/10.5281/zenodo.4421504 instead of https://zenodo.org/record/4421504/files/MissingIslands.zip).

@LaviniaBaumstark
Copy link
Member

I hope that deleting SSP2EU will not cause any problems

@johanneskoch94
Copy link
Member Author

I hope that deleting SSP2EU will not cause any problems

A SSP2EU scenario is still returned, a placeholder of sorts, that is an exact copy of SSP2. I think the downstream deletion of SSP2EU from the pipeline will take a bit more work...

R/calcGDPFuture.R Show resolved Hide resolved
Replace SSP2EU with a placeholder, as it no longer a desired scenario, but required in the input preparation pipeline. Remove completely in next release.
Add ADB sources and scenarios (not returned by default yet).
Urban pop share scenarios are improved, so as to never exceed 1, even with bezier extensions.
SSP labour scenarios are now also filled in with UN_popDiv data.
SSP population scenarios now use short term growth rates from PEAP-UN_PopDiv, instead of PEAP-MI, improving the shorterm projections of the smaller countries.
Refactor function arguments that did not comply with lintr rules (fixes pik-piam#13).
Mark "scenario.indicator" naming option as deprecated and remove in next release.
Fix all linter warnings.
Improve scenario documentation and references in vignette (fixes pik-piam#56 and fixes pik-piam#57).
Improve and simplify documentation (fixes pik-piam#16).
Remove "unit" from most functions, assuming instead that the default dollar unit is used throughout the package.
Clean up use of James data set for filling and backwards extension to 1960. These two functions are now cleanly separated from each other. Also, use of the James2019 dataset is dropped (fixes pik-piam#62), due to the fact that there is no reference for this dataset. This does not affect the scenarios much since the dataset is mainly used for its growth rates, and they shouldn't differ to much.
Refactor toolReduce and toolFillWith. toolFillWith now writes to the log which countries are filled in.
Export some of the more useful tool functions.
Speed up bezier extension (fixes pik-piam#78).
Remove MI from future datasets and make it clear that we assume constant extrapolation for most of the MI countries.
Fixes pik-piam#52.
Make choice of graphics device explicit when computing the bezier extensions (fixes pik-piam#79).
Remove || from unit field in calcOutput returns.
@johanneskoch94 johanneskoch94 marked this pull request as ready for review November 6, 2024 10:10
@johanneskoch94 johanneskoch94 merged commit 5ef20f4 into pik-piam:main Nov 6, 2024
3 checks passed
@johanneskoch94 johanneskoch94 deleted the INDhg branch November 6, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment