-
Notifications
You must be signed in to change notification settings - Fork 51
/
col_vals_not_between.R
618 lines (577 loc) · 21 KB
/
col_vals_not_between.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
#------------------------------------------------------------------------------#
#
# _ _ _ _ _
# (_) | | | | | | | |
# _ __ ___ _ _ __ | |_ | |__ | | __ _ _ __ | | __
# | '_ \ / _ \ | || '_ \ | __|| '_ \ | | / _` || '_ \ | |/ /
# | |_) || (_) || || | | || |_ | |_) || || (_| || | | || <
# | .__/ \___/ |_||_| |_| \__||_.__/ |_| \__,_||_| |_||_|\_\
# | |
# |_|
#
# This file is part of the 'rstudio/pointblank' project.
#
# Copyright (c) 2017-2024 pointblank authors
#
# For full copyright and license information, please look at
# https://rstudio.github.io/pointblank/LICENSE.html
#
#------------------------------------------------------------------------------#
#' Do column data lie outside of two specified values or data in other columns?
#'
#' @description
#'
#' The `col_vals_not_between()` validation function, the
#' `expect_col_vals_not_between()` expectation function, and the
#' `test_col_vals_not_between()` test function all check whether column values
#' in a table *do not* fall within a range. The range specified with three
#' arguments: `left`, `right`, and `inclusive`. The `left` and `right` values
#' specify the lower and upper bounds. The bounds can be specified as single,
#' literal values or as column names given in `vars()`. The `inclusive`
#' argument, as a vector of two logical values relating to `left` and `right`,
#' states whether each bound is inclusive or not. The default is `c(TRUE,
#' TRUE)`, where both endpoints are inclusive (i.e., `[left, right]`). For
#' partially-unbounded versions of this function, we can use the
#' [col_vals_lt()], [col_vals_lte()], [col_vals_gt()], or [col_vals_gte()]
#' validation functions. The validation function can be used directly on a data
#' table or with an *agent* object (technically, a `ptblank_agent` object)
#' whereas the expectation and test functions can only be used with a data
#' table. Each validation step or expectation will operate over the number of
#' test units that is equal to the number of rows in the table (after any
#' `preconditions` have been applied).
#'
#' @inheritParams col_vals_gt
#'
#' @param left *Definition of left bound*
#'
#' `<value expression>` // **required**
#'
#' The lower bound for the range. The validation includes this bound
#' value (if the first element in `inclusive` is `TRUE`) in addition to values
#' greater than `left`. This can be a single value or a compatible column
#' given in `vars()`.
#'
#' @param right *Definition of right bound*
#'
#' `<value expression>` // **required**
#'
#' The upper bound for the range. The validation includes this
#' bound value (if the second element in `inclusive` is `TRUE`) in addition to
#' values lower than `right`. This can be a single value or a compatible
#' column given in `vars()`.
#'
#' @param inclusive *Inclusiveness of bounds*
#'
#' `vector<logical>` // *default:* `c(TRUE, TRUE)`
#'
#' A two-element logical value that indicates whether the `left` and `right`
#' bounds should be inclusive. By default, both bounds are inclusive.
#'
#' @return For the validation function, the return value is either a
#' `ptblank_agent` object or a table object (depending on whether an agent
#' object or a table was passed to `x`). The expectation function invisibly
#' returns its input but, in the context of testing data, the function is
#' called primarily for its potential side-effects (e.g., signaling failure).
#' The test function returns a logical value.
#'
#' @section Supported Input Tables:
#'
#' The types of data tables that are officially supported are:
#'
#' - data frames (`data.frame`) and tibbles (`tbl_df`)
#' - Spark DataFrames (`tbl_spark`)
#' - the following database tables (`tbl_dbi`):
#' - *PostgreSQL* tables (using the `RPostgres::Postgres()` as driver)
#' - *MySQL* tables (with `RMySQL::MySQL()`)
#' - *Microsoft SQL Server* tables (via **odbc**)
#' - *BigQuery* tables (using `bigrquery::bigquery()`)
#' - *DuckDB* tables (through `duckdb::duckdb()`)
#' - *SQLite* (with `RSQLite::SQLite()`)
#'
#' Other database tables may work to varying degrees but they haven't been
#' formally tested (so be mindful of this when using unsupported backends with
#' **pointblank**).
#'
#' @section Column Names:
#'
#' `columns` may be a single column (as symbol `a` or string `"a"`) or a vector
#' of columns (`c(a, b, c)` or `c("a", "b", "c")`). `{tidyselect}` helpers
#' are also supported, such as `contains("date")` and `where(is.double)`. If
#' passing an *external vector* of columns, it should be wrapped in `all_of()`.
#'
#' When multiple columns are selected by `columns`, the result will be an
#' expansion of validation steps to that number of columns (e.g.,
#' `c(col_a, col_b)` will result in the entry of two validation steps).
#'
#' Previously, columns could be specified in `vars()`. This continues to work,
#' but `c()` offers the same capability and supersedes `vars()` in `columns`.
#'
#' @section Missing Values:
#'
#' This validation function supports special handling of `NA` values. The
#' `na_pass` argument will determine whether an `NA` value appearing in a test
#' unit should be counted as a *pass* or a *fail*. The default of `na_pass =
#' FALSE` means that any `NA`s encountered will accumulate failing test units.
#'
#' @section Preconditions:
#'
#' Providing expressions as `preconditions` means **pointblank** will preprocess
#' the target table during interrogation as a preparatory step. It might happen
#' that a particular validation requires a calculated column, some filtering of
#' rows, or the addition of columns via a join, etc. Especially for an
#' *agent*-based report this can be advantageous since we can develop a large
#' validation plan with a single target table and make minor adjustments to it,
#' as needed, along the way.
#'
#' The table mutation is totally isolated in scope to the validation step(s)
#' where `preconditions` is used. Using **dplyr** code is suggested here since
#' the statements can be translated to SQL if necessary (i.e., if the target
#' table resides in a database). The code is most easily supplied as a one-sided
#' **R** formula (using a leading `~`). In the formula representation, the `.`
#' serves as the input data table to be transformed (e.g., `~ . %>%
#' dplyr::mutate(col_b = col_a + 10)`). Alternatively, a function could instead
#' be supplied (e.g., `function(x) dplyr::mutate(x, col_b = col_a + 10)`).
#'
#' @section Segments:
#'
#' By using the `segments` argument, it's possible to define a particular
#' validation with segments (or row slices) of the target table. An optional
#' expression or set of expressions that serve to segment the target table by
#' column values. Each expression can be given in one of two ways: (1) as column
#' names, or (2) as a two-sided formula where the LHS holds a column name and
#' the RHS contains the column values to segment on.
#'
#' As an example of the first type of expression that can be used,
#' `vars(a_column)` will segment the target table in however many unique values
#' are present in the column called `a_column`. This is great if every unique
#' value in a particular column (like different locations, or different dates)
#' requires it's own repeating validation.
#'
#' With a formula, we can be more selective with which column values should be
#' used for segmentation. Using `a_column ~ c("group_1", "group_2")` will
#' attempt to obtain two segments where one is a slice of data where the value
#' `"group_1"` exists in the column named `"a_column"`, and, the other is a
#' slice where `"group_2"` exists in the same column. Each group of rows
#' resolved from the formula will result in a separate validation step.
#'
#' If there are multiple `columns` specified then the potential number of
#' validation steps will be `m` columns multiplied by `n` segments resolved.
#'
#' Segmentation will always occur after `preconditions` (i.e., statements that
#' mutate the target table), if any, are applied. With this type of one-two
#' combo, it's possible to generate labels for segmentation using an expression
#' for `preconditions` and refer to those labels in `segments` without having to
#' generate a separate version of the target table.
#'
#' @section Actions:
#'
#' Often, we will want to specify `actions` for the validation. This argument,
#' present in every validation function, takes a specially-crafted list
#' object that is best produced by the [action_levels()] function. Read that
#' function's documentation for the lowdown on how to create reactions to
#' above-threshold failure levels in validation. The basic gist is that you'll
#' want at least a single threshold level (specified as either the fraction of
#' test units failed, or, an absolute value), often using the `warn_at`
#' argument. This is especially true when `x` is a table object because,
#' otherwise, nothing happens. For the `col_vals_*()`-type functions, using
#' `action_levels(warn_at = 0.25)` or `action_levels(stop_at = 0.25)` are good
#' choices depending on the situation (the first produces a warning when a
#' quarter of the total test units fails, the other `stop()`s at the same
#' threshold level).
#'
#' @section Labels:
#'
#' `label` may be a single string or a character vector that matches the number
#' of expanded steps. `label` also supports `{glue}` syntax and exposes the
#' following dynamic variables contextualized to the current step:
#'
#' - `"{.step}"`: The validation step name
#' - `"{.col}"`: The current column name
#' - `"{.seg_col}"`: The current segment's column name
#' - `"{.seg_val}"`: The current segment's value/group
#'
#' The glue context also supports ordinary expressions for further flexibility
#' (e.g., `"{toupper(.step)}"`) as long as they return a length-1 string.
#'
#' @section Briefs:
#'
#' Want to describe this validation step in some detail? Keep in mind that this
#' is only useful if `x` is an *agent*. If that's the case, `brief` the agent
#' with some text that fits. Don't worry if you don't want to do it. The
#' *autobrief* protocol is kicked in when `brief = NULL` and a simple brief will
#' then be automatically generated.
#'
#' @section YAML:
#'
#' A **pointblank** agent can be written to YAML with [yaml_write()] and the
#' resulting YAML can be used to regenerate an agent (with [yaml_read_agent()])
#' or interrogate the target table (via [yaml_agent_interrogate()]). When
#' `col_vals_not_between()` is represented in YAML (under the top-level `steps`
#' key as a list member), the syntax closely follows the signature of the
#' validation function. Here is an example of how a complex call of
#' `col_vals_not_between()` as a validation step is expressed in R code and in
#' the corresponding YAML representation.
#'
#' R statement:
#'
#' ```r
#' agent %>%
#' col_vals_not_between(
#' columns = a,
#' left = 1,
#' right = 2,
#' inclusive = c(TRUE, FALSE),
#' na_pass = TRUE,
#' preconditions = ~ . %>% dplyr::filter(a < 10),
#' segments = b ~ c("group_1", "group_2"),
#' actions = action_levels(warn_at = 0.1, stop_at = 0.2),
#' label = "The `col_vals_not_between()` step.",
#' active = FALSE
#' )
#' ```
#'
#' YAML representation:
#'
#' ```yaml
#' steps:
#' - col_vals_not_between:
#' columns: c(a)
#' left: 1.0
#' right: 2.0
#' inclusive:
#' - true
#' - false
#' na_pass: true
#' preconditions: ~. %>% dplyr::filter(a < 10)
#' segments: b ~ c("group_1", "group_2")
#' actions:
#' warn_fraction: 0.1
#' stop_fraction: 0.2
#' label: The `col_vals_not_between()` step.
#' active: false
#' ```
#'
#' In practice, both of these will often be shorter as only the `columns`,
#' `left`, and `right` arguments require values. Arguments with default values
#' won't be written to YAML when using [yaml_write()] (though it is acceptable
#' to include them with their default when generating the YAML by other means).
#' It is also possible to preview the transformation of an agent to YAML without
#' any writing to disk by using the [yaml_agent_string()] function.
#'
#' @section Examples:
#'
#' The `small_table` dataset in the package has a column of numeric values in
#' `c` (there are a few `NA`s in that column). The following examples will
#' validate the values in that numeric column.
#'
#' ```{r}
#' small_table
#' ```
#'
#' ## A: Using an `agent` with validation functions and then `interrogate()`
#'
#' Validate that values in column `c` are all between `10` and `20`. Because
#' there are `NA` values, we'll choose to let those pass validation by setting
#' `na_pass = TRUE`. We'll determine if this validation has any failing test
#' units (there are 13 test units, one for each row).
#'
#' ```r
#' agent <-
#' create_agent(tbl = small_table) %>%
#' col_vals_not_between(
#' columns = c,
#' left = 10, right = 20,
#' na_pass = TRUE
#' ) %>%
#' interrogate()
#' ```
#'
#' Printing the `agent` in the console shows the validation report in the
#' Viewer. Here is an excerpt of validation report, showing the single entry
#' that corresponds to the validation step demonstrated here.
#'
#' \if{html}{
#' \out{
#' `r pb_get_image_tag(file = "man_col_vals_not_between_1.png")`
#' }
#' }
#'
#' ## B: Using the validation function directly on the data (no `agent`)
#'
#' This way of using validation functions acts as a data filter. Data is passed
#' through but should `stop()` if there is a single test unit failing. The
#' behavior of side effects can be customized with the `actions` option.
#'
#' ```{r}
#' small_table %>%
#' col_vals_not_between(
#' columns = c,
#' left = 10, right = 20,
#' na_pass = TRUE
#' ) %>%
#' dplyr::pull(c)
#' ```
#'
#' ## C: Using the expectation function
#'
#' With the `expect_*()` form, we would typically perform one validation at a
#' time. This is primarily used in **testthat** tests.
#'
#' ```r
#' expect_col_vals_not_between(
#' small_table, columns = c,
#' left = 10, right = 20,
#' na_pass = TRUE
#' )
#' ```
#'
#' ## D: Using the test function
#'
#' With the `test_*()` form, we should get a single logical value returned to
#' us.
#'
#' ```{r}
#' small_table %>%
#' test_col_vals_not_between(
#' columns = c,
#' left = 10, right = 20,
#' na_pass = TRUE
#' )
#' ```
#'
#' An additional note on the bounds for this function: they are inclusive by
#' default. We can modify the inclusiveness of the upper and lower bounds with
#' the `inclusive` option, which is a length-2 logical vector.
#'
#' In changing the lower bound to be `9` and making it non-inclusive, we get
#' `TRUE` since although two values are `9` and they fall outside of the lower
#' (or left) bound (and any values 'not between' count as passing test units).
#'
#' ```{r}
#' small_table %>%
#' test_col_vals_not_between(
#' columns = c,
#' left = 9, right = 20,
#' inclusive = c(FALSE, TRUE),
#' na_pass = TRUE
#' )
#' ```
#'
#' @family validation functions
#' @section Function ID:
#' 2-8
#'
#' @seealso The analogue to this function: [col_vals_between()].
#'
#' @name col_vals_not_between
NULL
#' @rdname col_vals_not_between
#' @import rlang
#' @export
col_vals_not_between <- function(
x,
columns,
left,
right,
inclusive = c(TRUE, TRUE),
na_pass = FALSE,
preconditions = NULL,
segments = NULL,
actions = NULL,
step_id = NULL,
label = NULL,
brief = NULL,
active = TRUE
) {
# Capture the `columns` expression
columns <- rlang::enquo(columns)
# Get `columns` as a label
columns_expr <- as_columns_expr(columns)
# Resolve the columns based on the expression
columns <- resolve_columns(x = x, var_expr = columns, preconditions)
# Resolve segments into list
segments_list <-
resolve_segments(
x = x,
seg_expr = segments,
preconditions = preconditions
)
# Set names on the `left` and `right` values
left <- stats::setNames(left, inclusive[1])
right <- stats::setNames(right, inclusive[2])
if (is_a_table_object(x)) {
secret_agent <-
create_agent(x, label = "::QUIET::") %>%
col_vals_not_between(
columns = tidyselect::all_of(columns),
left = left,
right = right,
inclusive = inclusive,
na_pass = na_pass,
preconditions = preconditions,
segments = segments,
label = label,
brief = brief,
actions = prime_actions(actions),
active = active
) %>%
interrogate()
return(x)
}
agent <- x
if (is.null(brief)) {
brief <-
generate_autobriefs(
agent = agent,
columns = columns,
preconditions = preconditions,
values = c(left, right),
assertion_type = "col_vals_not_between"
)
}
# Normalize any provided `step_id` value(s)
step_id <- normalize_step_id(step_id, columns, agent)
# Get the next step number for the `validation_set` tibble
i_o <- get_next_validation_set_row(agent)
# Check `step_id` value(s) against all other `step_id`
# values in earlier validation steps
check_step_id_duplicates(step_id, agent)
# Add one or more validation steps based on the
# length of the `columns` variable
label <- resolve_label(label, columns, segments_list)
for (i in seq_along(columns)) {
for (j in seq_along(segments_list)) {
seg_col <- names(segments_list[j])
seg_val <- unname(unlist(segments_list[j]))
agent <-
create_validation_step(
agent = agent,
assertion_type = "col_vals_not_between",
i_o = i_o,
columns_expr = columns_expr,
column = columns[i],
values = c(left, right),
na_pass = na_pass,
preconditions = preconditions,
seg_expr = segments,
seg_col = seg_col,
seg_val = seg_val,
actions = covert_actions(actions, agent),
step_id = step_id[i],
label = label[[i, j]],
brief = brief[i],
active = active
)
}
}
agent
}
#' @rdname col_vals_not_between
#' @import rlang
#' @export
expect_col_vals_not_between <- function(
object,
columns,
left,
right,
inclusive = c(TRUE, TRUE),
na_pass = FALSE,
preconditions = NULL,
threshold = 1
) {
fn_name <- "expect_col_vals_not_between"
vs <-
create_agent(tbl = object, label = "::QUIET::") %>%
col_vals_not_between(
columns = {{ columns }},
left = {{ left }},
right = {{ right }},
inclusive = inclusive,
na_pass = na_pass,
preconditions = {{ preconditions }},
actions = action_levels(notify_at = threshold)
) %>%
interrogate() %>%
.$validation_set
x <- vs$notify
threshold_type <- get_threshold_type(threshold = threshold)
if (threshold_type == "proportional") {
failed_amount <- vs$f_failed
} else {
failed_amount <- vs$n_failed
}
# If several validations were performed serially (due to supplying
# multiple columns)
if (length(x) > 1 && any(x)) {
# Get the index (step) of the first failure instance
fail_idx <- which(x)[1]
# Get the correct, single `failed_amount` for the first
# failure instance
failed_amount <- failed_amount[fail_idx]
# Redefine `x` as a single TRUE value
x <- TRUE
} else {
x <- any(x)
fail_idx <- 1
}
if (inherits(vs$capture_stack[[1]]$warning, "simpleWarning")) {
warning(conditionMessage(vs$capture_stack[[1]]$warning))
}
if (inherits(vs$capture_stack[[1]]$error, "simpleError")) {
stop(conditionMessage(vs$capture_stack[[1]]$error))
}
act <- testthat::quasi_label(enquo(x), arg = "object")
column_text <- prep_column_text(vs$column[[fail_idx]])
value_1 <-
prep_values_text(
values = vs$values[[fail_idx]][[1]], limit = 3, lang = "en"
)
value_2 <-
prep_values_text(
values = vs$values[[fail_idx]][[2]], limit = 3, lang = "en"
)
testthat::expect(
ok = identical(!as.vector(act$val), TRUE),
failure_message = glue::glue(
failure_message_gluestring(
fn_name = fn_name, lang = "en"
)
)
)
act$val <- object
invisible(act$val)
}
#' @rdname col_vals_not_between
#' @import rlang
#' @export
test_col_vals_not_between <- function(
object,
columns,
left,
right,
inclusive = c(TRUE, TRUE),
na_pass = FALSE,
preconditions = NULL,
threshold = 1
) {
vs <-
create_agent(tbl = object, label = "::QUIET::") %>%
col_vals_not_between(
columns = {{ columns }},
left = {{ left }},
right = {{ right }},
inclusive = inclusive,
na_pass = na_pass,
preconditions = {{ preconditions }},
actions = action_levels(notify_at = threshold)
) %>%
interrogate() %>%
.$validation_set
if (inherits(vs$capture_stack[[1]]$warning, "simpleWarning")) {
warning(conditionMessage(vs$capture_stack[[1]]$warning))
}
if (inherits(vs$capture_stack[[1]]$error, "simpleError")) {
stop(conditionMessage(vs$capture_stack[[1]]$error))
}
all(!vs$notify)
}