Skip to content
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

Closes #218 modified row merge (#219) #220

Merged
merged 3 commits into from
Apr 12, 2024
Merged

Closes #218 modified row merge (#219) #220

merged 3 commits into from
Apr 12, 2024

Conversation

nicholas-masel
Copy link
Collaborator

@nicholas-masel nicholas-masel commented Mar 29, 2024

  • modified row merge

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.

  • The spirit of logrx is met in your Pull Request
  • Check that your Pull Request is targeting the dev branch, Pull Requests to master should use the Release Pull Request Template
  • 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 .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Run 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 check locally 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!

* modified row merge
@bms63
Copy link
Collaborator

bms63 commented Mar 29, 2024

Umm...the Update Branch has me a little worried.

@kodesiba
Copy link
Collaborator

kodesiba commented Apr 1, 2024

Umm...the Update Branch has me a little worried.

@bms63 what do you mean by this? If it's about the "bypass branch protections" I believe that is because of the windows R CMD check failing and if that's happening other places I'm happy to bypass them.

@kodesiba
Copy link
Collaborator

kodesiba commented Apr 1, 2024

@bms63 sorry for the double tag but it looks like there was a merge commit added with the last merge to main so it is technically one commit ahead but it is just a merge commit. I think we would want to update with a rebase to get the merge commit in the chain before this commit instead of a merge which might put it after this commit in the chain

@bms63
Copy link
Collaborator

bms63 commented Apr 1, 2024

I think we are good to go!!

What do you all think about just removing the dev branch? We could also adopt the pkgodwn dev-mode for the website too!?!

@bms63
Copy link
Collaborator

bms63 commented Apr 7, 2024

Did this get sent to CRAN?

@kodesiba
Copy link
Collaborator

@bms63 just noticed your message. I have not sent it to CRAN yet, wasn't sure if we did that before or after the merge to main. Happy to send it along whenever

@bms63
Copy link
Collaborator

bms63 commented Apr 10, 2024

I wish these window checks would pass. i think send from dev. after it is live we can merge to main

@kodesiba
Copy link
Collaborator

@bms63 would it be worth switching to the admiralci action instead? looks like most of the other packages in pharmaverse use that so we could go that direction instead of banging our heads against this wall

@bms63
Copy link
Collaborator

bms63 commented Apr 10, 2024

I'm hesitant to use admiral's CI as they are kind of complicated.

Looking at r-lib/actions I see our version are behind...did a quick update to see if maybe that helps!?!

@bms63
Copy link
Collaborator

bms63 commented Apr 10, 2024

Hey!! that worked!!

@kodesiba
Copy link
Collaborator

@bms63 @nicholas-masel I can get this sent off to CRAN this afternoon and we can merge this whenever

@kodesiba
Copy link
Collaborator

day late but R didn't want to be friendly to Windows like always, it's off to CRAN @bms63 @nicholas-masel

@kodesiba kodesiba merged commit f6c24f8 into main Apr 12, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants