Skip to content

Conversation

@Kcdahn
Copy link
Collaborator

@Kcdahn Kcdahn commented Nov 12, 2025

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 main 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?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and 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.)
  • 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 under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • 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!

@Kcdahn Kcdahn linked an issue Nov 12, 2025 that may be closed by this pull request
@github-actions
Copy link

github-actions bot commented Nov 12, 2025

Code Coverage

Package Line Rate Health
admiral 100%
Summary 100% (6070 / 6083)

@Kcdahn Kcdahn changed the title Initial Add. Closes #2897 Nov 12, 2025
@Kcdahn Kcdahn changed the title Closes #2897 Closes #2897 ADAB Vignette Nov 12, 2025
Copy link
Contributor

Copilot AI left a 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.

Copy link
Collaborator

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

Copy link
Collaborator

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

Kristin Dahnert and others added 8 commits November 26, 2025 01:12
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>
Comment on lines 37 to 40
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.
Copy link
Collaborator

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?

Copy link
Collaborator Author

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.

Copy link
Collaborator Author

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.

Kcdahn and others added 2 commits January 6, 2026 14:26
Co-authored-by: Ben Straub <ben.x.straub@gsk.com>
Co-authored-by: Ben Straub <ben.x.straub@gsk.com>
@bms63
Copy link
Collaborator

bms63 commented Jan 6, 2026

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

@Kcdahn
Copy link
Collaborator Author

Kcdahn commented Jan 6, 2026

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

@bms63
Copy link
Collaborator

bms63 commented Jan 6, 2026

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

@bms63
Copy link
Collaborator

bms63 commented Jan 6, 2026

@Kcdahn functions are merged in - please proceed.

@bms63
Copy link
Collaborator

bms63 commented Jan 6, 2026

Looks like Code Styler actions is failing on the vignette

Kcdahn and others added 6 commits January 6, 2026 17:57
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.
@Kcdahn
Copy link
Collaborator Author

Kcdahn commented Jan 7, 2026

I added the main adab.R template code updates related to derive_var_nfrlt() updates and added/changed some related verbiage.
The Styler issue was some dataset_vignette() adds needed styling.

@bms63
Copy link
Collaborator

bms63 commented Jan 7, 2026

Just a couple of additions to spelling wordlist and then I think we are good!?!

Kcdahn and others added 2 commits January 7, 2026 11:24
Co-authored-by: Jeff Dickinson <jeff.dickinson@navitaslifesciences.com>
@Kcdahn Kcdahn requested a review from jeffreyad January 7, 2026 17:39
@bms63
Copy link
Collaborator

bms63 commented Jan 7, 2026

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

@bms63 bms63 merged commit 299a37a into main Jan 7, 2026
16 checks passed
@bms63 bms63 deleted the 2873-documentation-adab-vignette branch January 7, 2026 18:32
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: ADAB Vignette

5 participants