Skip to contents

Affirmation Report

Source: R/affirm_report.R
affirm_report.Rd

  • affirm_report_gt() returns styled gt table summarizing results of affirmation session.

  • affirm_report_excel() returns excel file with one sheet per affirmation (excluding those with no errors)

  • affirm_report_raw_data() returns raw data used to generate summary in affirm_report_gt()

Usage

affirm_report_gt(variable_labels = FALSE)

affirm_report_excel(file, variable_labels = FALSE, overwrite = TRUE)

affirm_report_raw_data(variable_labels = FALSE)

Arguments

variable_labels

logical indicating whether to add a row to exported data with the variable labels. If label does not exist, the variable name is printed. Default is FALSE

file

A file path to save the xlsx file

overwrite

Overwrite existing file (Defaults to TRUE as with write.table)

Value

gt table

Examples

affirm_init(replace = TRUE)
#> ✔ We're ready to make data affirmations...

as_tibble(mtcars) |>
 affirm_true(
   label = "No. cylinders must be 4, 6, or 8",
   condition = cyl %in% c(4, 6, 8)
 ) |>
 affirm_true(
    label = "MPG should be less than 33",
    condition = mpg < 33
 )
#> • No. cylinders must be 4, 6, or 8
#>   0 issues identified.
#> • MPG should be less than 33
#>   1 issue identified.
#> # A tibble: 32 × 11
#>      mpg   cyl  disp    hp  drat    wt  qsec    vs    am  gear  carb
#>    <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl>
#>  1  21       6  160    110  3.9   2.62  16.5     0     1     4     4
#>  2  21       6  160    110  3.9   2.88  17.0     0     1     4     4
#>  3  22.8     4  108     93  3.85  2.32  18.6     1     1     4     1
#>  4  21.4     6  258    110  3.08  3.22  19.4     1     0     3     1
#>  5  18.7     8  360    175  3.15  3.44  17.0     0     0     3     2
#>  6  18.1     6  225    105  2.76  3.46  20.2     1     0     3     1
#>  7  14.3     8  360    245  3.21  3.57  15.8     0     0     3     4
#>  8  24.4     4  147.    62  3.69  3.19  20       1     0     4     2
#>  9  22.8     4  141.    95  3.92  3.15  22.9     1     0     4     2
#> 10  19.2     6  168.   123  3.92  3.44  18.3     1     0     4     4
#> # ℹ 22 more rows

gt_report <- affirm_report_gt()

affirm_close()