generated from pharmaverse/admiraltemplate
-
Notifications
You must be signed in to change notification settings - Fork 6
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
Deprecation 2.0 #466
Comments
bms63
added a commit
that referenced
this issue
Oct 8, 2024
14 tasks
bms63
added a commit
that referenced
this issue
Nov 15, 2024
bms63
added a commit
that referenced
this issue
Nov 15, 2024
bms63
added a commit
that referenced
this issue
Nov 15, 2024
bms63
added a commit
that referenced
this issue
Nov 15, 2024
bms63
added a commit
that referenced
this issue
Nov 15, 2024
bms63
added a commit
that referenced
this issue
Dec 6, 2024
bms63
added a commit
that referenced
this issue
Dec 18, 2024
bms63
added a commit
that referenced
this issue
Dec 18, 2024
bms63
added a commit
that referenced
this issue
Dec 20, 2024
bms63
added a commit
that referenced
this issue
Dec 20, 2024
bms63
added a commit
that referenced
this issue
Dec 22, 2024
github-project-automation
bot
moved this from Backlog
to Archive
in admiral (sdtm/adam, dev, ci, template, core)
Dec 23, 2024
bms63
added a commit
that referenced
this issue
Jan 11, 2025
14 tasks
bms63
added a commit
that referenced
this issue
Jan 11, 2025
bms63
added a commit
that referenced
this issue
Jan 14, 2025
bundfussr
added a commit
that referenced
this issue
Jan 14, 2025
bms63
added a commit
that referenced
this issue
Jan 14, 2025
bundfussr
added a commit
that referenced
this issue
Jan 15, 2025
bms63
added a commit
that referenced
this issue
Jan 15, 2025
* docs: #466 deprecate 2.0 * docs: #466 unit tests and roxygen * chore: #466 news * chore: #466 pkgdown yml * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * feat: #466 inform function skeleton and tests * feat: looking at snapshot options with lifecycle * docs: #466 news entry for function and some general guidance for reference page * docs: #466 inserted details in guidance * docs: #466 feedback from review * docs: #466 more feedback adopted from review * docs: #466 lets read! * chore: #466 that lintr life * chore: #466 making it work again * chore: #466 style me baby!! * chore: #466 lints and docs * chore: #446 unclear on doc updates * docs: #466 wordsmithing fun for deprecation!! * chore: #466 styling and spelling * chore: #466 docs * chore: #466 namespace * feat: #466 arguments from lifecycle for environments * chore: #466 argument hell * feat: #466 include all arguments; todo: figure out NA issue * docs: #466 getting pretty; environment tweaks * documentation udpate * doc update * doc update * chore: #466 spelling * Update admiraldev.Rproj * docs: #466 improving msg * chore: #466 indentation * docs: #466 finalize dep prog strat * chore: #466 #480 removed devcontainer; spelling * docs: #456 upversion R in description * chore: news entries for all issues * #466 deprecation: fix NEWS * fix: #466 PR review updates * fix: #466 PR review updates * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * Update vignettes/programming_strategy.Rmd Co-authored-by: Stefan Bundfuss <[email protected]> * chore: #466 style dep functions * #466 deprecation: update phase 2 of unit tests * fix: #466 comments from PR review * chore: #466 wordsmith * #466 deprecation: update changes to deprecated function --------- Co-authored-by: Stefan Bundfuss <[email protected]> Co-authored-by: Daniel Sjoberg <[email protected]> Co-authored-by: Stefan Bundfuss <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Discussed in pharmaverse/admiral#2329
Originally posted by bms63 February 6, 2024
Strategy pre-1.0.0
From programming strategy guide - https://pharmaverse.github.io/admiraldev/articles/programming_strategy.html#deprecation
=====
As admiral is still evolving, functions or arguments may need to be removed or replaced with more efficient options from one release to another. In such cases, the relevant function or argument must be marked as deprecated. This deprecation is done in three phases over our release cycles.
Phase 1: In the release where the identified function or argument is to be deprecated there will be a warning issued when using the function or argument using deprecate_warn().
Phase 2: In the next release an error will be thrown using deprecate_stop().
Phase 3: Finally in the 3rd release thereafter the function will be removed from the package altogether.
Information about deprecation timelines must be added to the warning/error message.
Note that the deprecation cycle time for a function or argument based on our current release schedule is 3 months.
=====
This was a move fast and break things type of process.
Strategy at 1.0.0
This has not been codified into any guide only discussed on GitHub.
Functions and arguments that we created pre-1.0.0 are being carried through with our deprecation cycle (see above)
We are currently embracing superseded as a way to recommend functions to users that replace current functions
In our new paradigm we are no longer deprecating any functions or arguments in admiral.
Pro: Increases stability for new users
Con: Increases code base to maintain for developers
Con: More functions in reference documents increases search time for users...confusion.
Strategy post-1.0.0
Perhaps we should continue to deprecate functions through a process of superseding and then deprecating over a three year cycle.
Proposal:
Functions that are
supersededdeprecated are given a two-year message cycleAfter two-year
supersededdeprecated function message is reached the message turns into a 1 year deprecation function warningAfter 1 year deprecation is reached the function is removed from the package
Pro: Reduces number of functions we have to maintain
Pro: Users are less overwhelmed with function options
Con: Users will have to update their code over time
Con: Developers have to maintain the cycle
The text was updated successfully, but these errors were encountered: