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 #64 adding dataset logo #69

Merged
merged 5 commits into from
May 28, 2024
Merged

closes #64 adding dataset logo #69

merged 5 commits into from
May 28, 2024

Conversation

sadchla-codes
Copy link
Contributor

@sadchla-codes sadchla-codes commented May 21, 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 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!

@sadchla-codes sadchla-codes linked an issue May 21, 2024 that may be closed by this pull request
@kaz462
Copy link
Contributor

kaz462 commented May 21, 2024

@sadchla-codes Since the dataset documentation was generated by create_adams_data.R, could you help populate labels in "Datasets" sheet from the spec? I can add xportr::xportr_df_label to create_adams_data.R after the spec updates. Thank you!

@sadchla-codes
Copy link
Contributor Author

@sadchla-codes Since the dataset documentation was generated by create_adams_data.R, could you help populate labels in "Datasets" sheet from the spec? I can add xportr::xportr_df_label to create_adams_data.R after the spec updates. Thank you!

Sure, I'll work on that

R/adpp.R Outdated
@@ -1,4 +1,4 @@
#' Dataset adpp
#' Analysis Dataset of Pharmacokinetics Parameters
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
#' Analysis Dataset of Pharmacokinetics Parameters
#' Analysis Dataset of Pharmacokinetic Parameters

@@ -1,4 +1,4 @@
#' Dataset advs
#' Vital Signs Analysis
Copy link
Collaborator

Choose a reason for hiding this comment

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

General comment: sometimes you use "Dataset" (ie Vital Signs Analysis Dataset) and sometimes not (Vital Signs Analysis). Wondering if we can choose one approach here? Maybe just always omit? What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree that omitting it would look much better aesthetically, I'll make that update.

R/adae.R Show resolved Hide resolved
@kaz462 kaz462 merged commit 550eda5 into main May 28, 2024
16 checks passed
@kaz462 kaz462 deleted the 64_documentation_improvement branch May 28, 2024 16:15
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.

Documentation: Update the package icon
3 participants