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 #2551 file restructure #2633

Merged
merged 13 commits into from
Jan 10, 2025
Merged

Closes #2551 file restructure #2633

merged 13 commits into from
Jan 10, 2025

Conversation

bms63
Copy link
Collaborator

@bms63 bms63 commented Jan 9, 2025

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@bms63 bms63 linked an issue Jan 9, 2025 that may be closed by this pull request
@bms63
Copy link
Collaborator Author

bms63 commented Jan 9, 2025

Hi @luenhchang I renamed your branch and created the Pull Request.

Are you still able to work on this - we need to complete by Friday EOD.

Copy link

github-actions bot commented Jan 9, 2025

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (5209 / 5323)

@bundfussr bundfussr self-requested a review January 9, 2025 16:24
Copy link
Collaborator

@bundfussr bundfussr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The files in tests/testthat/_snaps need to be updated:

  • The current changes need to be reverted.
  • The files derive_adeg_params.md and derive_advs_params.md need to be removed.
  • Files for the new test files need to be added.

This should fix the failing checks.

inst/WORDLIST Outdated Show resolved Hide resolved
@jeffreyad
Copy link
Collaborator

Hi @luenhchang I renamed your branch and created the Pull Request.

Are you still able to work on this - we need to complete by Friday EOD.

Hi @luenhchang and @bms63 let me know if you need help implementing the changes. I have some time today

@bms63
Copy link
Collaborator Author

bms63 commented Jan 10, 2025

@jeffreyad you are an angel of admiral!! please if you are able to fix the snapshots I would be so grateful.

The onboarding can get removed from wordlist

@bms63
Copy link
Collaborator Author

bms63 commented Jan 10, 2025

@bundfussr this looks good to me

@bms63 bms63 merged commit 3c882c8 into main Jan 10, 2025
19 checks passed
@bms63 bms63 deleted the 2551_file_restructure branch January 10, 2025 16:10
@luenhchang
Copy link
Collaborator

@bms63
happy to help. I can see these two files in my local folder
tests\testthat_snaps\derive_adeg_params.md
tests\testthat_snaps\derive_advs_params.md

Should I get them deleted and push the changes?

In my git bash, the main local folder is still with the feature/my_first_fcn, as shown from
luenh@Lun-Hsien_Chang MINGW64 /c/GoogleDrive_MyDrive/GitHub/admiral-development/admiral (feature/my_first_fcn)

How do I change this before pushing the changes?

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.

General Issue: Restructure Files for ADEG and ADVS Parameters
4 participants