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

Closes #2185 additional implementation of keep_source_vars #2215

Closed
wants to merge 13 commits into from

Conversation

zdz2101
Copy link
Collaborator

@zdz2101 zdz2101 commented Nov 2, 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 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 devel 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?
  • 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)
  • 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!

Copy link

github-actions bot commented Nov 2, 2023

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (4587 / 4673)

@zdz2101 zdz2101 marked this pull request as ready for review November 6, 2023 16:07
Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

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

I feel like the vignettes need to be updated that use this function

@zdz2101 zdz2101 requested a review from bms63 November 8, 2023 18:44
@@ -422,7 +431,7 @@ derive_param_tte <- function(dataset = NULL,
}

adsl <- dataset_adsl %>%
select(!!!adsl_vars)
select(!!!adsl_vars, !!!keep_source_vars)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Using keep_source_vars here is different from the other functions. Usually it is used to specify the variables which should be kept from the selected records. To be consistent we would need to add keep_source_vars to event_source() and censor_source(). However, I am not sure if this is a good idea (especially if the default is exprs(everything()) because different source datasets could be used. For example if event_source() uses ADRS and censor_source() uses ADSL, all ADRS and all ADSL variables would be added to the new records but the ADSL variables would be populated for censored records only.

Therefore I think we should not add keep_source_vars to derive_param_tte().

@bms63 , what do you think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@bms63 @bundfussr I think it's fine if we don't implement it here too, derive_param_tte() seems hyperspecific for users, in which case we can just close the PR as well

Copy link
Collaborator

Choose a reason for hiding this comment

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

I am fine to not implement this change. @zdz2101 when you return - can you make a note of this in the function re-work documents.

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: keep_source_var to be applicable across appropriate family of functions
4 participants