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 #26 rename/rerun programs from admiral.test/admiralvaccine #38

Merged
merged 13 commits into from
Jul 19, 2023

Conversation

kaz462
Copy link
Contributor

@kaz462 kaz462 commented Jul 18, 2023

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 devel 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?
  • 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 if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • 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!

@kaz462 kaz462 changed the title 26 rerun admiraltest dev Closes #26 rename/rerun programs from admiral.test/admiralvaccine Jul 18, 2023
This was linked to issues Jul 18, 2023
@kaz462
Copy link
Contributor Author

kaz462 commented Jul 18, 2023

Summary of the updates:

  1. replace dev folder by data-raw
  2. remove prefix admiral_ in both programs and datasets
  3. rename update_domain.R programs to domain.R
  4. add programs for ex/cm/sv/ts/vs/dm (direct copy from CDISC pilot study)
  5. add set.seed in pc.R/qs_ophtha.R to avoid changes for future rerun

@pharmaverse/admiraldata
I removed all raw_domain.rda data, and updated to read them directly from the URL. Do you see any issues with this approach? should we save a copy of the raw data under data-raw folder?

@manciniedoardo
Copy link
Collaborator

Thanks for working on this @kaz462 - there are a few things I would change in the individual scripts to make them tidier and more homogeneous, but as discussed yesterday for nowit's more important to get the package structure nailed down.

@bundfussr
Copy link
Contributor

I removed all raw_domain.rda data, and updated to read them directly from the URL. Do you see any issues with this approach? should we save a copy of the raw data under data-raw folder?

I think that's OK because it is unlikely that the CDISC pilot data is removed or changed.

@kaz462 kaz462 mentioned this pull request Jul 19, 2023
@kaz462 kaz462 merged commit 36bb03f into devel Jul 19, 2023
22 of 23 checks passed
@kaz462 kaz462 deleted the 26_rerun_admiraltest_dev branch July 28, 2023 19:52
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.

Naming convention Rerun dev folder, fix issue in pp.R
3 participants