Check region code and name combinations

Checks that all region_code and region_name combinations in the data file are valid. For Regional rows, all combinations must be valid. For non-Regional rows, only non-empty, non-NA combinations are checked. Rows where region_code is "x" (the GSS not-available code) are excluded from non-Regional checks.

Usage

check_geog_region_combos(data, verbose = FALSE, stop_on_error = FALSE)

Arguments

data

A data frame of the data file

verbose

logical, if TRUE prints feedback messages to console for every test, if FALSE run silently

stop_on_error

logical, if TRUE will stop with an error if the result is "FAIL", and will throw genuine warning if result is "WARNING"

Value

a single row data frame

Details

If either region column is absent from the data, the check passes immediately.

See also

Other check_geog: check_geog_country_combos(), check_geog_eda_combos(), check_geog_ignored_rows(), check_geog_la_col_present(), check_geog_la_combos(), check_geog_lad_combos(), check_geog_lep_combos(), check_geog_level_completed(), check_geog_lsip_combos(), check_geog_na(), check_geog_na_code(), check_geog_other_code_dupes(), check_geog_other_dupes(), check_geog_overcompleted_cols(), check_geog_pcon_combos(), check_geog_region_col_present(), check_geog_region_for_la(), check_geog_region_for_lad(), check_geog_ward_combos()

Examples

check_geog_region_combos(example_data)
#>                check result
#> 1 geog_region_combos   PASS
#>                                                                                   message
#> 1 At least one of the region_code / region_name columns is not present in this data file.
#>   guidance_url
#> 1           NA
check_geog_region_combos(example_data, verbose = TRUE)
#> ✔ At least one of the region_code / region_name columns is not present in this data file.
#>                check result
#> 1 geog_region_combos   PASS
#>                                                                                   message
#> 1 At least one of the region_code / region_name columns is not present in this data file.
#>   guidance_url
#> 1           NA