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 #93 Update readme and doc script #94

Merged
merged 12 commits into from
Dec 3, 2024

Conversation

vbshuliar
Copy link
Collaborator

@vbshuliar vbshuliar commented Nov 19, 2024

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 pharmaverseadam site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new datasets 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!

@vbshuliar vbshuliar self-assigned this Nov 19, 2024
@vbshuliar vbshuliar changed the title #93 Update readme and doc script Closes #93 Update readme and doc script Nov 19, 2024
@vbshuliar
Copy link
Collaborator Author

The create_adams_data.R script has to be rerun in order to generate new scripts with the updated documentation. I can't do it from my PC as GitHub puts a limit on the amount of API calls.

Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

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

Great work! Left a couple of comments.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@manciniedoardo
Copy link
Collaborator

@vbshuliar in addition to my above review can you please also restructure the reference page so that it talks about datasets and not functions? thanks

Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

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

LGTM - thanks @vbshuliar

@manciniedoardo manciniedoardo merged commit 2d94d3b into main Dec 3, 2024
16 checks passed
@manciniedoardo manciniedoardo deleted the 93-update-readme-and-documentation branch December 3, 2024 10:17
@manciniedoardo manciniedoardo restored the 93-update-readme-and-documentation branch December 11, 2024 14:28
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.

Update readme and documentation to be more informative with the description of documentation process
2 participants