assertive (version 0.3-0)

assert_all_are_uk_postcodes: Is the string a valid UK postcode?

Description

Checks that the input contains UK postcodes.

Usage

assert_all_are_uk_postcodes(x, na_ignore = FALSE)

assert_any_are_uk_postcodes(x, na_ignore = FALSE)

is_uk_postcode(x)

Arguments

x

Input to check.

na_ignore

A logical value. If FALSE, NA values cause an error; otherwise they do not. Like na.rm in many stats package functions, except that the position of the failing values does not change.

Value

• is_uk_postcode returns TRUE if the input string contains a valid UK postcode. The {assert_*} function returns nothing but throws an error when the is_* function returns FALSE.

References

Regexes taken from https://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom#Validation.

Examples

postcodes <- c(
  "SW1A 1AA", "SK11 9DW", "M34FP", "Le45ns", "TS25 2BZ", "gir 0aa"
)
is_uk_postcode(postcodes)
assert_all_are_uk_postcodes(postcodes)