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 #2126 unify_joined: update derive_vars_joined(), derive_var_joined_exist_flag(), filter_joined() #2163

Merged
merged 35 commits into from
Nov 6, 2023

Conversation

bundfussr
Copy link
Collaborator

@bundfussr bundfussr commented Oct 10, 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!

@bundfussr bundfussr linked an issue Oct 11, 2023 that may be closed by this pull request
@github-actions
Copy link

github-actions bot commented Oct 16, 2023

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (4550 / 4624)

@bundfussr bundfussr marked this pull request as ready for review October 19, 2023 15:50
@bundfussr bundfussr requested a review from jeffreyad as a code owner October 19, 2023 15:50
@bundfussr bundfussr requested review from bms63 and zdz2101 and removed request for jeffreyad October 19, 2023 15:51
inst/templates/ad_adpc.R Outdated Show resolved Hide resolved
NEWS.md Show resolved Hide resolved
@bundfussr bundfussr requested a review from bms63 October 20, 2023 10:41
Copy link
Collaborator

@zdz2101 zdz2101 left a comment

Choose a reason for hiding this comment

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

small documentation stuff

R/derive_joined.R Show resolved Hide resolved
#'
#' 1. The joined dataset is restricted by the `filter_join` condition.
#'
#' @keywords internal
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
#' @keywords internal
#' @keywords internal
#' @export

Although it will only be used internally, are we not exporting this function at all?

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 think if we export it, it should be included on the "Reference" page, i.e., it should not be internal.

Do you think it users would like to use it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I doubt our users would use it, but it feels like it has similar "use" as assert_terms() and assert_valid_queries() which are both exported, more for a consistency thing

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, but it seems that we want to change this (see #2085 (reply in thread)).
@bms63 , what do you think?

@bundfussr bundfussr requested a review from zdz2101 October 31, 2023 17:05
R/derive_joined.R Outdated Show resolved Hide resolved
vignettes/generic.Rmd Outdated Show resolved Hide resolved
vignettes/hys_law.Rmd Outdated Show resolved Hide resolved
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.

Hey @bundfussr - feel free to take or not take any of my suggestions or musings. This one was a bit of epic review!! I think we are good to go once you look through my suggestions.

@bundfussr bundfussr requested a review from bms63 November 6, 2023 12:14
@bms63 bms63 merged commit 5a0f7ed into main Nov 6, 2023
15 checks passed
@bms63 bms63 deleted the 2126_unify_joined branch November 6, 2023 18:33
@bundfussr bundfussr restored the 2126_unify_joined branch November 16, 2023 09:56
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: Unify *joined* functions
4 participants