Closes #103 - Documentation: Align pharmaverseadam Documentation Style with pharmaversesdtm Reference Page

[vbshuliar]

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]

[manciniedoardo]

@vbshuliar is there more to do here?

[vbshuliar]

@vbshuliar is there more to do here?

The issues is not resolved yet

[vbshuliar]

Note for the Person Taking Over

Objective

The main goal of this pull request is to implement the same architecture and styling for the reference page of the pharmaverseadam documentation as I previously did for the pharmaversesdtm package.

Recommended Steps

To ensure consistency and get a better understanding of the intended structure:

1. Visit the pharmaversesdtm reference page to see how it is structured:
   Pharmaversesdtm Reference Page
2. Review the corresponding pull request for pharmaversesdtm, including all comments and discussions, for more context on the approach and decisions made:
   Pharmaversesdtm Pull Request #130

Context

Due to the need to prioritize other work, I wasn't able to complete this task. Please feel free to make any necessary adjustments.

Support

If you need any clarifications, feel free to reach out.

Thanks for picking this up, and good luck! 🚀

[manciniedoardo]

@vbshuliar thanks for this. Can you please explain how far you got and what is left?

[vbshuliar]

I am assigning myself to this pull request again as I have more capacity now.

[manciniedoardo]

@vbshuliar can you please link an issue that can be associated to this PR, or create one?

[vbshuliar]

@vbshuliar can you please link an issue that can be associated to this PR, or create one?

#103

[manciniedoardo]

LGTM!