feat: improve error message when getting an invalid .data #339
+23
−1
Conversation
This file contains 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
maelle
commented
Nov 14, 2024
| @@ -33,7 +33,10 @@ as_duckplyr_df <- function(.data) { | |||
| } | |||
|
|
|||
| if (!identical(class(.data), "data.frame") && !identical(class(.data), c("tbl_df", "tbl", "data.frame"))) { | |||
| cli::cli_abort("Must pass a plain data frame or a tibble to `as_duckplyr_df()`.") | |||
| cli::cli_abort(c( | |||
| "Must pass a plain data frame or a tibble to `as_duckplyr_df()`, not {.obj_type_friendly { .data}}.", | |||
There was a problem hiding this comment.
the space before .data is compulsory, I got this error from cli:
Error in "fun(..., .envir = .envir)" :
! Invalid cli literal: `{.data}` starts with a dot.
ℹ Interpreted literals must not start with a dot in cli >= 3.4.0.
ℹ `{}` expressions starting with a dot are now only used for cli styles.
ℹ To avoid this error, put a space character after the starting `{` or use parentheses: `{(.data)}`.
There was a problem hiding this comment.
This should then be a comment, and/or a test.
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if cf2b613 is merged into main:
Further explanation regarding interpretation and methodology can be found in the documentation. |
krlmlr
reviewed
Nov 15, 2024
| @@ -33,7 +33,10 @@ as_duckplyr_df <- function(.data) { | |||
| } | |||
|
|
|||
| if (!identical(class(.data), "data.frame") && !identical(class(.data), c("tbl_df", "tbl", "data.frame"))) { | |||
| cli::cli_abort("Must pass a plain data frame or a tibble to `as_duckplyr_df()`.") | |||
| cli::cli_abort(c( | |||
| "Must pass a plain data frame or a tibble to `as_duckplyr_df()`, not {.obj_type_friendly { .data}}.", | |||
There was a problem hiding this comment.
This should then be a comment, and/or a test.
maelle
commented
Nov 15, 2024
|
|
||
| by_cyl <- dplyr::group_by(mtcars, cyl) | ||
| expect_snapshot(error = TRUE, { | ||
| as_duckplyr_df(by_cyl) |
There was a problem hiding this comment.
maybe in this case the error is misleading, would you convert a grouped data.frame by converting it thus losing its grouping
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if e718a07 is merged into main:
Further explanation regarding interpretation and methodology can be found in the documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix #127
Not docs but this was a low-hanging fruit to warm up. 😉