Implement filter_out()
#7775
Open
Implement filter_out()
#7775
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
DavisVaughan
force-pushed
the
feature/filter-out-2
branch
from
ea193ab to
3155f84
Compare
BECAUSE THIS IS HARD Y'ALL
DavisVaughan
commented
Nov 25, 2025
Comment on lines
+3
to
+19
| * New experimental `filter_out()` companion to `filter()`. | ||
|
|
||
| * Use `filter()` when specifying rows to _keep_. | ||
|
|
||
| * Use `filter_out()` when specifying rows to _drop_. | ||
|
|
||
| `filter_out()` simplifies cases where you would have previously used a `filter()` to drop rows. It is particularly useful when missing values are involved. For example, to drop rows where the `count` is zero: | ||
|
|
||
| ```r | ||
| df |> filter(count != 0 | is.na(count)) | ||
|
|
||
| df |> filter_out(count == 0) | ||
| ``` | ||
|
|
||
| With `filter()`, you must provide a "negative" condition of `!= 0` and must explicitly guard against accidentally dropping rows with `NA`. With `filter_out()`, you directly specify rows to drop and you don't have to guard against dropping rows with `NA`, which tends to result in much clearer code. | ||
|
|
||
| This work is a result of [Tidyup 8: Expanding the `filter()` family](https://github.com/tidyverse/tidyups/pull/30), with a lot of great feedback from the community (#6560, #6891). |
Comment on lines
+217
to
+223
| #' @rdname filter | ||
| #' @export | ||
| filter_out <- function(.data, ..., .by = NULL, .preserve = FALSE) { | ||
| check_by_typo(...) | ||
| check_not_both_by_and_preserve({{ .by }}, .preserve) | ||
| UseMethod("filter_out") | ||
| } |
Member
Author
There was a problem hiding this comment.
The actual implementation is quite simple
- Extract out a common
filter_impl() - Provide
.verb = "filter"or.verb = "filter_out"- If
filter_out, provideinvert = TRUEto the C implementation of filter, which inverts the final result on the way out
- If
| @@ -1,17 +1,108 @@ | |||
| #' Keep rows that match a condition | |||
Member
Author
There was a problem hiding this comment.
Did a full doc overhaul. Things worth spending time on:
- The Description section
- Note that I've declared
filter_out()as experimental
- Note that I've declared
@section Missing values:- Examples
Comment on lines
+185
to
+189
| if (LOGICAL_ELT(invert, 0)) { | ||
| for (R_xlen_t i = 0; i < n; ++i) { | ||
| p_keep[i] = !p_keep[i]; | ||
| } | ||
| } |
Member
Author
There was a problem hiding this comment.
I carefully looked at all filter() tests and added a corresponding filter_out() test if it felt like the test wasn't too niche and generally tested some kind of invariant (0 row behavior, no input behavior, etc)
| `across()` doesn't work with `select()` or `rename()` because they already use tidy select syntax; if you want to transform column names with a function, you can use `rename_with()`. | ||
| ### filter() |
Member
Author
There was a problem hiding this comment.
Tweaked the vignettes only where it felt like using filter_out() was a noticeable improvement
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.
Closes #6560
Closes #6891
Part of tidyverse/tidyups#30