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

sdtm.oak SDTM spec, Algorithms Documentation and template r code for cm domain #30

Merged
merged 23 commits into from
Jan 31, 2024

Conversation

rammprasad
Copy link
Collaborator

@rammprasad rammprasad commented Dec 6, 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 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.

  • Place Closes Documentation: Template R code #17 into the beginning of your Pull z
    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 oak 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!

@rammprasad rammprasad linked an issue Dec 6, 2023 that may be closed by this pull request
Copy link

github-actions bot commented Jan 16, 2024

Code Coverage

Package Line Rate Health
sdtm.oak 88%
Summary 88% (241 / 273)

@rammprasad
Copy link
Collaborator Author

@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?

@ramiromagno
Copy link
Collaborator

ramiromagno commented Jan 17, 2024

@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?

@galachad galachad requested a review from kamilsi January 24, 2024 17:38
Copy link
Collaborator

@kamilsi kamilsi left a 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.

.github/CONTRIBUTING.md Show resolved Hide resolved
DESCRIPTION Show resolved Hide resolved
inst/cm_domain/create_cm_template.R Outdated Show resolved Hide resolved
inst/cm_domain/create_cm_template.R Show resolved Hide resolved
inst/cm_domain/create_cm_template.R Outdated Show resolved Hide resolved
vignettes/articles/study_sdtm_spec.Rmd Show resolved Hide resolved
vignettes/articles/study_sdtm_spec.Rmd Show resolved Hide resolved
vignettes/articles/study_sdtm_spec.Rmd Outdated Show resolved Hide resolved
vignettes/articles/study_sdtm_spec.Rmd Show resolved Hide resolved
vignettes/articles/study_sdtm_spec.Rmd Show resolved Hide resolved
@edgar-manukyan
Copy link
Collaborator

@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.
I also added example SDTM CM datasets.

Please review/approve so that Ramiro can kindly proceed with derive implementation.

@edgar-manukyan edgar-manukyan merged commit e6e8d7d into main Jan 31, 2024
1 check passed
@edgar-manukyan edgar-manukyan deleted the 17-documentation-template-r-code branch January 31, 2024 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Documentation: Template R code
6 participants