Compute a Filter Predicate — get_filter

Computes a logical vector indicating which elements of x match the filter criteria specified by val.

Usage

get_filter_logical(x, val, ...)

Arguments

x: An object to filter; typically a data.frame.
val: The filter criteria.
...: Arguments passed to methods. See details.

Value

A logical vector indicating which elements of x match the filter criteria specified by val.

Details

The following arguments are supported in ...:

column: When x is a data.frame, column is the name of the column intended to be filtered.
comparison: When x is a numeric or Date and val is a length-one numeric or Date, comparison is the function used to compare x with val. The default is <=.
gte: When x is a numeric or Date and val is a length-two numeric or Date, gte controls whether to use >= (TRUE, default) or > (FALSE) on val[[1]].
lte: When x is a numeric or Date and val is a length-two numeric or Date, lte controls whether to use <= (TRUE, default) or < (FALSE) on val[[2]].

Examples

df <- data.frame(
  category = rep(letters[1:3], each = 4),
  value = 1:12,
  date = Sys.Date() + 0:11
)

# Filter character column
get_filter_logical(df, c("a", "b"), column = "category")
#>  [1]  TRUE  TRUE  TRUE  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE FALSE FALSE

# Filter numeric column with single value
get_filter_logical(df, 5, column = "value", comparison = `<=`)
#>  [1]  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE

# Filter numeric column with range
get_filter_logical(df, c(3, 8), column = "value", gte = TRUE, lte = FALSE)
#>  [1] FALSE FALSE  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE FALSE FALSE FALSE