-
Notifications
You must be signed in to change notification settings - Fork 13
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
sdtm.oak SDTM spec, Algorithms Documentation and template r code for cm domain #30
Conversation
Merge branch 'main' into 17-documentation-template-r-code # Conflicts: # DESCRIPTION
@ramiromagno - One of the iso8601 test cases fail in the rcmd check PR. Will you be able to check the pipeline and take a look? |
Hello Ram, yes, I will look into it! EDIT: Hi again Ram, I can't really see which are the fails. Could you provide the direct link to the workflow instance that generates the fail? |
…/pharmaverse/sdtm.oak into 17-documentation-template-r-code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I want to express my sincere appreciation for your efforts in making sdtm.oak
more approachable. This is a crucial step in ensuring that documentation is accessible to a broader audience.
Having worked as a developer for many years on SDTM, I can personally attest to the challenges posed by the numerous acronyms and specialized terminology within this domain. Even with my experience, I still find myself struggling with some of the many, many acronyms present here.
Given this, I wholeheartedly support the @ramiromagno idea of creating a dictionary, as he suggested on Slack. Such a resource would undoubtedly be a valuable asset, not only for newcomers but also for seasoned professionals like myself. It would greatly enhance our understanding of the content and make sdtm.oak
even more user-friendly.
@kamilsi, @ramiromagno, thanks so much for your review and suggestions. Please note that I addressed couple of them in this PR and also opened #38 to address the remaining in the future. Please review/approve so that Ramiro can kindly proceed with |
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 oak 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.Request Title (Use Edit button in top-right if you need to update)
tidyverse style guide. Run
styler::style_file()
to style R and Rmd filesconsider realistic data scenarios and edge cases, e.g. empty datasets, errors,
boundary cases etc. - See
Unit Test Guide
fully follow the
deprecation guidance?
and families. Refer to the
categorization of functions to tag appropriate keyword/family.
devtools::document()
so all.Rd
files in theman
folder and theNAMESPACE
file in the project root are updated appropriatelyNEWS.md
if the changes pertain to a user-facing function (i.e. ithas an
@export
tag) or documentation aimed at users (rather than developers)pkgdown::build_site()
and check that all affectedexamples are displayed correctly and that all new functions occur on the "Reference" page.
lintr::lint_package()
R CMD check
locally and address all errors and warnings -devtools::check()