fix: remove 'card' class after unlist_ard_columns() and rename_ard_columns()#566
Open
Melkiades wants to merge 2 commits into
Open
Conversation
…lumns() After unlisting or renaming, the result no longer satisfies the ARD contract (list columns have been flattened or group/variable columns renamed). Introduce 'card_unlisted' and 'card_renamed' subclasses to signal this. - unlist_ard_columns(): returns class 'card_unlisted' - rename_ard_columns(): returns class 'card_renamed', accepts both 'card' and 'card_unlisted' as input - Functions requiring a proper ARD (apply_fmt_fun, replace_null_statistic, etc.) continue to require class 'card' and will reject the new subclasses Closes insightsengineering#513
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes are proposed in this pull request?
unlist_ard_columns()andrename_ard_columns()now return objects with class"card_unlisted"and"card_renamed"respectively, instead of retaining the"card"class. (Removecardclass afterunlist_ard_columns()#513)After unlisting or renaming, the result no longer satisfies the ARD contract (list columns have been flattened or group/variable columns renamed). The new subclasses signal this so that functions requiring a proper ARD (
apply_fmt_fun(),replace_null_statistic(), etc.) will reject these objects with a clear error.rename_ard_columns()now accepts both"card"and"card_unlisted"as input, supporting bothrename |> unlistandunlist |> renameorderings.Reference GitHub issue associated with pull request.
Closes #513
Pre-review Checklist (if item does not apply, mark is as complete)
usethis::pr_merge_main()devtools::test_coverage()