Closes #221

[nicholas-masel]

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 dev branch until you have checked off each task.

• [x] The spirit of logrx is met in your Pull Request
• [x] Code is formatted according to the tidyverse style guide
• [x] 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().
• [x] Creation/updates to relevant roxygen headers and examples.
• [x] Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
• [x] Run pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
• [x] 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)
• [x] Address any updates needed for vignettes and/or templates
• [x] Run R CMD check locally and address all errors and warnings - devtools::check()
• [x] Link the issue so that it closes after successful merging.
• [x] Address all merge conflicts and resolve appropriately
• [x] Pat yourself on the back for a job well done! Much love to your accomplishment!

[nicholas-masel]

Does this get rid of the message to users about not having lintr installed?

No, if get_lint_results() is called and lintr is not installed, it will message users.

It looks like we need a check here to see if the option is turned on to lint, if so, then call get_lint_results().

Or we just update get_lint_results() to move the package check inside the if statement that is checking the option.

[bms63]

Does this get rid of the message to users about not having lintr installed?

No, if get_lint_results() is called and lintr is not installed, it will message users.

It looks like we need a check here to see if the option is turned on to lint, if so, then call get_lint_results().

yeah - id really like to not have this message appear as it confuses users. shall we make a separate issue for this update?

[nicholas-masel]

Does this get rid of the message to users about not having lintr installed?

No, if get_lint_results() is called and lintr is not installed, it will message users. It looks like we need a check here to see if the option is turned on to lint, if so, then call get_lint_results().

yeah - id really like to not have this message appear as it confuses users. shall we make a separate issue for this update?

Yep, let's do that and I can put the fix in.

[kodesiba]

@nicholas-masel is this the first PR in the chain? Was going to try and get through these this week so we don't have all of these just hanging out

[nicholas-masel]

@nicholas-masel is this the first PR in the chain? Was going to try and get through these this week so we don't have all of these just hanging out

You should be able to approve/merge in whatever order without issues. This one is pretty straightforward though.