Ensure invisibly returned objects are not printed in log#285
Open
parmsam-pfizer wants to merge 7 commits intomainfrom
Open
Ensure invisibly returned objects are not printed in log#285parmsam-pfizer wants to merge 7 commits intomainfrom
parmsam-pfizer wants to merge 7 commits intomainfrom
Conversation
parmsam-pfizer
changed the title
visible = TRUE to purrr::safely() call for run_safely
Collaborator
Author
|
Still working on this. Should have update soon. |
…tion of the log (#275)
Collaborator
Author
|
Sorry, for the delay. Should be updated now. Please let me know if you have any questions or suggestions. Feel free to make any needed edits. |
… and ensure trailing newline
kodesiba
previously approved these changes
Mar 6, 2026
Collaborator
|
I have this tagged in the callr update to check out but the tests being here already is really good to have |
bms63
reviewed
Mar 6, 2026
Comment on lines
+1
to
+3
| my_fun <- function(x) { | ||
| return(invisible(x)) | ||
| } |
Collaborator
There was a problem hiding this comment.
is this enough?? - can we make something a little more involved to make sure nothing is carried through?
unsure if this even returns anything.
the culprit is gt package which returns a lot of html formatting into the console which runs the risk of getting printed to our log
Collaborator
There was a problem hiding this comment.
would agree with adding a test for gt, this is the function from the reprex though
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Associated with #275.
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.log_remove().devtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelypkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.R CMD checklocally and address all errors and warnings -devtools::check()