Skip to content

Closes #292 add ader template#331

Open
jeffreyad wants to merge 16 commits intomainfrom
292-feature-request-add-ader-template-for-exposure-response-data
Open

Closes #292 add ader template#331
jeffreyad wants to merge 16 commits intomainfrom
292-feature-request-add-ader-template-for-exposure-response-data

Conversation

@jeffreyad
Copy link
Copy Markdown
Collaborator

@jeffreyad jeffreyad commented Jan 20, 2026

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). Then the issue is closed automatically once it is merged to main.
  • 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 - 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
  • 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
  • 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 so that it closes after successful merging.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

The following line requests to update the man pages by the "Man Pages" workflow.

/roxygenize

@jeffreyad jeffreyad linked an issue Jan 20, 2026 that may be closed by this pull request
@jeffreyad jeffreyad linked an issue Jan 20, 2026 that may be closed by this pull request
@jeffreyad jeffreyad marked this pull request as draft January 20, 2026 00:15
@jeffreyad jeffreyad changed the title #292 add ader template Closes #292 add ader template Jan 20, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 20, 2026

Code Coverage

Package Line Rate Health
admiralonco 97%
Summary 97% (614 / 630)

@jeffreyad jeffreyad marked this pull request as ready for review January 28, 2026 16:31
@jeffreyad jeffreyad requested a review from Copilot January 28, 2026 16:32
@jeffreyad jeffreyad requested review from Kcdahn and bundfussr January 28, 2026 16:35
Copy link
Copy Markdown

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 pull request adds a new ADER (Exposure Response Data) template to the admiralonco package. The template is designed to create analysis datasets for exposure-response modeling by combining time-to-event data, response data, and various baseline covariates including demographics, vital signs, and laboratory values.

Changes:

  • Added inst/templates/ad_ader.R template for creating ADER datasets with exposure-response variables, covariates, and baseline measurements

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +21 to +22
data("admiral_adsl")
data("admiral_adrs")
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template uses data("admiral_adsl") and data("admiral_adrs") which is inconsistent with other templates in this package that use data("adsl") and data("adrs_onco") respectively. This inconsistency may cause issues if these dataset names don't exist in the expected packages. Review other templates (e.g., inst/templates/ad_adtte.R line 20, inst/templates/ad_adrs.R line 22) for the correct dataset names to ensure consistency.

Copilot uses AI. Check for mistakes.
jeffreyad and others added 8 commits January 28, 2026 14:36
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
adsl <- admiral_adsl
adrs <- admiral_adrs

adtte <- pharmaverseadam::adtte_onco
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bundfussr and @manciniedoardo If I want to include adtte_onco as source, should it also be saved in {admiralonco}? Currently it is pulled from {pharmaverseadam}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pulling from pharmaverseadam would introduce a circular dependency because pharmaverseadam itself has a dependency on admiralonco. So I would say yes.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. In the other templates we use the ADaM datasets from pharmaverseadam. Even in the vignettes we use them. So it shouldn't cause technical issues.

The only tricky scenario I'm aware of is when for example adrs_onco changes. In this case we would need to release admiralonco with the updated ADRS template, then release pharmaverseadam with the updated adrs_onco dataset, and finally recreate the admiralonco website to use the updated adrs_onco dataset in the ADTTE vignette.

Maybe we should remove admiral_adrs from admiralonco it seems that it isn't used anywhere.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, if that works then it's fine - personally i'd rather not have all these steps but final call is yours of course!

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By the way, I think even in ad_adtte.R the data("adrs_onco") is pulling from {pharmaverseadam} rather than the local admiral_adrs object.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I would use the datasets from pharmaverseadam. Whenever this causes issues in the future we can change it. But I think it's very unlikely.

Copy link
Copy Markdown
Collaborator

@bundfussr bundfussr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeffreyad , could you create a vignette for these templates?

I think with a vignette it is easier for users to understand (and find) these templates.

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.

Feature Request: Add ADER template for exposure response data

4 participants