Make as card check format #534
Open
Conversation
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
Contributor
|
✅ All contributors have signed the CLA |
Author
|
I have read the CLA Document and I hereby sign the CLA |
kieranjmartin
force-pushed
the
514_as_card
branch
from
087a156 to
f4f5ec2
Compare
Melkiades
reviewed
Dec 16, 2025
Comment on lines
+80
to
+83
| # Check whether expected columns are present --------------------------------- | ||
|
|
||
|
|
||
|
|
Contributor
There was a problem hiding this comment.
I think it is missing something
Melkiades
reviewed
Dec 16, 2025
| .message_or_error( | ||
| "The following columns are expected to be list columns: {.val {not_a_lst_columns}}.", | ||
| error = error_on_fail, | ||
| envir = environment() |
Contributor
There was a problem hiding this comment.
is this needed if default is rlang::current_env()?
Melkiades
reviewed
Dec 16, 2025
Comment on lines
+47
to
+48
| return(out) | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| return(out) | |
| out |
Melkiades
reviewed
Dec 16, 2025
|
|
||
| # check in inputs ------------------------------------------------------------ | ||
| check_class(x, cls = "data.frame") | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| check_scalar_logical(check) | |
Melkiades
reviewed
Dec 16, 2025
Melkiades
reviewed
Dec 16, 2025
Comment on lines
+14
to
+16
| expect_no_error( | ||
| check_ard_structure(data.frame(badname = 3)) | ||
| ) |
Contributor
There was a problem hiding this comment.
Suggested change
| expect_no_error( | |
| check_ard_structure(data.frame(badname = 3)) | |
| ) | |
| expect_no_error( | |
| check_ard_structure(data.frame(badname = 3)) | |
| ) |
Melkiades
reviewed
Dec 16, 2025
| ) | ||
| }) | ||
|
|
||
|
|
Melkiades
reviewed
Dec 16, 2025
Comment on lines
+112
to
+113
| #' cards:::..warn_or_error("This will be a message", FALSE) | ||
| #' cards:::..warn_or_error("This will be an error", TRUE) |
Contributor
There was a problem hiding this comment.
this should be message_or_error right?
Melkiades
reviewed
Dec 16, 2025
|
|
||
| #' Message or error | ||
| #' | ||
| #' Either error or message depending on input |
Contributor
There was a problem hiding this comment.
Suggested change
| #' Either error or message depending on input | |
| #' Either error or message depending on input. |
Melkiades
reviewed
Dec 16, 2025
| #' @param msg (scalar `character`)\cr | ||
| #' Error message | ||
| #' @param error (scalar `logical`)\cr | ||
| #' If this should produce an error or a warning. FALSE by default |
Contributor
There was a problem hiding this comment.
Suggested change
| #' If this should produce an error or a warning. FALSE by default | |
| #' If this should produce an error or a warning. FALSE by default |
Melkiades
reviewed
Dec 16, 2025
| #' Environment to evaluate the glue expressions in passed in `cli::cli_abort(message)`. | ||
| #' Default is `rlang::current_env()` | ||
| #' @inheritParams cli::cli_abort | ||
| #' @return Invisible NULL |
Contributor
There was a problem hiding this comment.
I am not sure this is needed. Also it is internal
Melkiades
reviewed
Dec 16, 2025
Comment on lines
+124
to
+125
| return(invisible()) | ||
|
|
Contributor
There was a problem hiding this comment.
Suggested change
| return(invisible()) |
Maybe without this completely?
Melkiades
reviewed
Dec 16, 2025
|
|
||
| } | ||
|
|
||
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Resolves #514
Incorportating
check_ard_structureintoas_cardproved to not be straight forwards asas_cardis used throughout the code base to coerce objects into a card class that do not pass the checks incheck_ard_structure.For now at least I did the following
check_ard_structurecan either error or warn based on user input. I made a function to switch between these (I couldn't see any function which existed to do this already). Part of me wonders about allowing the user a bit more control over what it considers an error or a warning; they can switch off caring about the column order, and whether there is a methods entry, but maybe we could allow more in future. That said I think it's probably better as a binary switch for a changeas_card, there is now an argument for whether you want to check if a card follows this structure. At the moment this defaults to TRUE, but if you think this is too strong I could switch it to default FALSE. Doing that would be the most low impact change.