Consider deprecating `join_abcd_scenario` and `summarize_*`

RMI-PACTA / r2dii.analysis

Tools to Calculate Climate Targets for Financial Portfolios

https://rmi-pacta.github.io/r2dii.analysis

Other

11 stars 9 forks source link

Consider deprecating `join_abcd_scenario` and `summarize_*` #468

Open jdhoffa opened 7 months ago

jdhoffa commented 7 months ago

These functions are currently exported, but I have no idea if anybody uses them. To some extent, it feels like we are committing ourselves to a maintenance burden for a decision made long ago.

I am curious if @jacobvjk thinks they are actively used (beyond when they are called in the body of target_* functions) Curious also how @AlexAxthelm and @cjyetman feel about this (not the details, but in general the process of deprecating a previously exported function)

It feels like probably a bad idea/ bad form, but want your opinions here.

AB#9903

cjyetman commented 7 months ago

I think that's what "deprecation" is intended for, no?

AlexAxthelm commented 7 months ago

Yeah, Let's support them for another few months, and then internalize them.

jdhoffa commented 7 months ago

Maybe more concretely, my question is:

Should I include, in the next release that I push to CRAN, a warning message explaining that we plan to deprecate these functions? (and maybe even a link to making an issue to this repo in case people wish for us to not deprecate them)?

I think this may be an appropriate strategy here

AlexAxthelm commented 7 months ago

I think this is exactly what deprecate_soft() is for, no? Anyone who calls the function directly sees the deprecation warning, anyone who uses it indirectly gets the expected result, some time later, we'll unexport them.

jdhoffa commented 7 months ago

Sounds perfect!

jdhoffa commented 7 months ago

Help achieved :-) thank you both.