-
Notifications
You must be signed in to change notification settings - Fork 86
Closes #2897 ADAB Vignette #2897
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
Conversation
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.
Pull request overview
This PR adds a comprehensive vignette for creating Anti-Drug Antibody (ADA) ADaM datasets (ADAB). The vignette provides detailed guidance on processing immunogenicity data from SDTM IS and EX domains into a parameter-based ADaM structure, covering both baseline and post-baseline ADA assessments as well as neutralizing antibody (NAB) status.
Key Changes
- New ADAB vignette (
vignettes/adab.Rmd) demonstrating the complete workflow for creating an Anti-Drug Antibody ADaM dataset with 1,583 lines of comprehensive documentation and code examples - Updated package documentation (
_pkgdown.yml) to include navigation link to the new ADAB vignette - Coverage of both SDTM v1.x and v2.0 standards with guidance on handling differences in variable naming conventions
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 20 comments.
| File | Description |
|---|---|
| vignettes/adab.Rmd | Comprehensive vignette providing step-by-step guidance for creating ADAB datasets, including data staging, parameter derivation, baseline/post-baseline flagging, treatment-emergent categorization, and final dataset assembly |
| _pkgdown.yml | Added navigation entry for the new ADAB vignette in the articles section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Fanny-Gautier
left a comment
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.
Same comments as in the template to be implemented here.
Fanny-Gautier
left a comment
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.
Thank you for providing such a detailed vignette on the complex ADA dataset derivation!
Please find my comments from the first review. Feel free to implement them as you see fit.
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
Co-authored-by: Fanny Gautier <157114584+Fanny-Gautier@users.noreply.github.com>
vignettes/adab.Rmd
Outdated
| output. For purposes of the examples, the surrogate data for ADA is called | ||
| `IS_ADA`. `IS_ADA` is a product of the pharmaverse `IS_ADA` data. The `IS` | ||
| domain is intended for multiple classes of findings so a dedicated `IS_ADA` was | ||
| added to the `{pharmaversesdtm}` for ADA data. |
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'm a little confused here
IS_ADA is a product of the pharmaverse IS_ADA data. ??
what does that mean?
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'll update this. I had copied part of the verbiage from another vignette.
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 just updated it, take a look.
Co-authored-by: Ben Straub <ben.x.straub@gsk.com>
Co-authored-by: Ben Straub <ben.x.straub@gsk.com>
|
@Kcdahn - I'm happy to get this merged in today if you can fix the "verbiage". I did a quick read and looks great! A little over my head but wow so much to learn!! Thanks for driving and putting together!! |
|
@bms63 What about my updates due to Jeff's derive_var_nfrlt() I have to add code and verbiage for that function but it doesn't work or test yet from my vignette branch. We could merge this to Main now then update it again in Jeff's NFRLT branch. Up to you. |
Okay - I requested the experimental badges be added to those two functions. I only glanced at the functions but they look great to me. The tests are really thorough. |
|
@Kcdahn functions are merged in - please proceed. |
|
Looks like Code Styler actions is failing on the vignette |
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
…new derive_var_nfrlt() function. Ran Styler.
|
I added the main adab.R template code updates related to derive_var_nfrlt() updates and added/changed some related verbiage. |
|
Just a couple of additions to spelling wordlist and then I think we are good!?! |
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
|
Brilliant job all! I think it has been a while since we had a new vignette and template. maybe a year since Jeff did the PC ones?? |
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
mainbranch until you have checked off each task.styler::style_file()to style R and Rmd filesinst/cheatsheet/admiral_cheatsheet.pptxand re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)devtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdunder the header# admiral (development version)if the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers). A Developer Notes section is available inNEWS.mdfor tracking developer-facing issues.pkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.lintr::lint_package()R CMD checklocally and address all errors and warnings -devtools::check()