Repository navigation
Deprecated remove_log_object in log_write. Closes #298 - #315
Praveenksmp06 wants to merge 4 commits into
Conversation
| \item{remove_log_object}{(Deprecated) Boolean. Should the log object be | ||
| removed after writing the log file? Defaults to TRUE. | ||
| This argument will be removed after the one-year deprecation period.} |
There was a problem hiding this comment.
@Praveenksmp06 we can fully remove this stuff!!
There was a problem hiding this comment.
ohh....were we already deprecating this argument or is this a fresh deprecation?
There was a problem hiding this comment.
I referred to the background in issue #298. I understood that remove_log_object was still available in log_write(), so I started the deprecation process as mentioned in the Definition of Done. I didn't realise it had already been deprecated earlier. If it's been in the deprecation cycle for a year, I'm happy to remove it completely!
There was a problem hiding this comment.
thanks yeah lets just fully remove !! tyty
There was a problem hiding this comment.
made the change in recent commit. Let me know if any more changes are required
| lifecycle::deprecate_stop("0.3.0", "axecute(remove_log_object = )", "axecute(include_rds = )") | ||
| } |
| if (!missing(remove_log_object)) { | ||
| lifecycle::deprecate_warn( | ||
| "0.5.0", | ||
| "log_write(remove_log_object = )" | ||
| ) | ||
| } |
There was a problem hiding this comment.
I think since we had this in deprecation cycle for so long we can just fully remove it all
|
@Praveenksmp06 amazing - can you just do a quick search and confirm that the argument isn't anywhere else in the documentation of other functions or vignettes please |
@bms63 I've completed the repository-wide search and confirmed that there are no remaining usages of remove_log_object other than the current removal entry and an older historical entry in NEWS.md. |
|
@nicholas-masel and @kodesiba WDYT!?! looks good to me!! |
Thank you for your Pull Request!
We have developed a Pull Request template to aid you and our reviewers. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the logrx codebase remains robust and consistent.
The spirit of logrx
While many packages to facilitate the logging of code already exist in the R ecosystem, it is hard to find a solution that works well for clinical programming applications. Many logging implementations are more implicit and rely on user input to create the log for the execution of a script. While this is useful for logging specific events of an application, in clinical programming a log has a set purpose.
logrx is built around the concept of creating a log for the execution of an R script that provides an overview of what happened as well as the environment that it happened in. We set out to create a flexible logging utility that could provide the necessary information to anyone reviewing the code execution so they can recreate the execution environment and run the code for themselves. Please make sure your Pull Request meets this spirit of logrx.
Please check off each taskbox as an acknowledgment that you completed the task. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the
devbranch until you have checked off each task.The spirit of logrx is met in your Pull Request
Code is formatted according to the tidyverse style guide
Updated relevant unit tests or have written new unit tests. Remember to remove any configured log objects at the end of every test using
log_remove().Creation/updates to relevant roxygen headers and examples.
Run
devtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyRun
pkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
Address any updates needed for vignettes and/or templates
Run
R CMD checklocally and address all errors and warnings -devtools::check()Link the issue so that it closes after successful merging.
Address all merge conflicts and resolve appropriately
Pat yourself on the back for a job well done! Much love to your accomplishment!
Fixes Check on log_write and use of deprecated arugment #298