fix_region: Fix Misspelling of Adminstrative Regions

In BroVic/naijR: Operations to Ease Data Analyses Specific to Nigeria

Fix Misspelling of Adminstrative Regions

Description

Correct any misspelt names of administrative regions e.g. States and LGAs.

Usage

fix_region(x, ...)

## S3 method for class 'states'
fix_region(x, ...)

## S3 method for class 'lgas'
fix_region(x, interactive = FALSE, quietly = FALSE, graphic = FALSE, ...)

## Default S3 method:
fix_region(x, ...)

fix_region_manual(x, wrong, correct)

Arguments

x	An S3 object of class states or lgas. For fix_region.default, a character vector (or an object coercible to one) can be passed but only that for 'States' will be interpretable.
...	Arguments passed to methods.
interactive	Logical. When TRUE, the function prompts the user to interactively select the correct LGA names from a list of available options.
quietly	Logical; default argument is FALSE.
graphic	Whether to make use of native GUI elements (on Windows only).
wrong	The misspelt element(s) of x.
correct	The correction that is to be applied to the misspelt element(s)

Details

fix_region will look through a character vector and try to determine if State or LGA names have been wrongly entered. This presupposes that the atomic vector is of type character. It does not test any missing values in the vector, leaving them untouched.

fix_region_manual allows users to interactively and directly change update the spelling.

Value

The transformed object. If all names are correct, the object is returned unchanged.

Note

When passed a character vector of length 1L, in the case of a misspelt LGA, the function signals an error; the presumption is that a fix can readily be applied interactively. When all the items provided are misspelt, nothing happens, but the user is advised to use the appropriate constructor function so as to improve the accuracy of the repairs. When there is a mix of misspelt and properly spelt LGAs, other functionalities for fixing the mistakes are available via mode interactive.

Examples

try(fix_region("Owerri north")) # ERROR
fix_region(c("Owerri north", "Owerri West"))

x <- c("Pankshen", "Pankshin", "Q'uan Pam")
is_lga(x)
x <- fix_region(x, quietly = TRUE)
is_lga(x)
fix_region_manual(x, "Q'uan Pam", "Qua'an Pan")
all(is_lga(x))

BroVic/naijR documentation built on Oct. 15, 2024, 8:38 p.m.