Deprecating aedseo and tsd, renaming to seasonal_onset and to_time_series #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SofiaOtero
added
refactor
RasmusSkytte
approved these changes
Nov 5, 2024
There was a problem hiding this comment.
Overall looks good.
I have some minor suggestions and a few places where the renaming was missed.
Reading through the PR however, strengthens my belief that functions should just always be verbs.
I think it is confusing to the user that we both have a function called "seasonal_onset" and objects of class "seasonal_onset". As well a function called "tsd" and objects of class "tsd".
When reading the vignette, I keep having to focus on we hare talking about the function or the objects.
All of this could be avoided by renaming "tsd() -> "to_tsd()" and "seasonal_onset() -> detect_seasonal_onset()". Or something of the like.
SofiaOtero
changed the title
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is deprecating the aedseo and tsd function and renaming it as seasonal_onset and to_time_series.
Both functions can still be used, but have a deprecation warning.
NEWS.md