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

Updated documentation on cm_prtpScen switch that sets the pure rate of time preference #1760

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

dbantje
Copy link
Contributor

@dbantje dbantje commented Jul 26, 2024

Purpose of this PR

Just a small correction of the inline documentation for the switch cm_prtpScen which sets the pure rate of time preference. The description of the default option said "1%", but it is actually set to 1.5%:

(from core/datainput.gms)

*** define pm_prtp according to cm_prtpScen:
if(cm_prtpScen eq 1, pm_prtp(regi) = 0.015);
if(cm_prtpScen eq 3, pm_prtp(regi) = 0.03);

Type of change

(Make sure to delete from the Type-of-change list the items not relevant to your PR)

  • Documentation fix

Checklist:

  • My code follows the coding etiquette
  • I performed a self-review of my own code
  • I explained my changes within the PR, particularly in hard-to-understand areas
  • I checked that the in-code documentation is up-to-date
  • I adjusted the reporting in remind2 where it was needed (not needed)
  • I adjusted forbiddenColumnNames in readCheckScenarioConfig.R in case the PR leads to deprecated switches (not needed)
  • All automated model tests pass (FAIL 0 in the output of make test)

@dbantje dbantje added the documentation Improvements or additions to documentation label Jul 26, 2024
@@ -685,7 +685,7 @@ parameter
cm_prtpScen "pure rate of time preference standard values"
;
cm_prtpScen = 1; !! def = 1 !! regexp = 1|3
*' * (1): 1 %
Copy link
Member

Choose a reason for hiding this comment

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

I am confuesed...isn't it 1 in the line above?

Copy link
Contributor Author

@dbantje dbantje Jul 26, 2024

Choose a reason for hiding this comment

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

That had me confused too, but I think it is supposed to be just an index for the switch options. Because later it clearly says

*** define pm_prtp according to cm_prtpScen:
if(cm_prtpScen eq 1, pm_prtp(regi) = 0.015);
if(cm_prtpScen eq 3, pm_prtp(regi) = 0.03);

But I guess we could also just make this switch into a numerical one, so the switch value actually corresponds to the value of the pure rate of time preference. That would also a nice feature if one wants to vary the rate.

Copy link
Member

Choose a reason for hiding this comment

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

ah, thanks. Let's keep it as is

@dbantje dbantje merged commit 15c44c8 into remindmodel:develop Aug 5, 2024
2 checks passed
@dbantje dbantje deleted the prtp_docu branch August 5, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants