checkNamesUK: Check United Kingdom names

View source: R/UK.R

checkNamesUKR Documentation

Check United Kingdom names

Description

Check the differences between the names (or codes) given in input and the names (or codes) of the corresponding selected United Kingdom statistical unit.

Usage

checkNamesUK(id, unit = c("country", "county"), 
             year = c("2020", "2019"), 
             matchWith = c("name", "code"), 
             scale = c("500", "20"), return_logical = FALSE, 
             print = TRUE, use_internet = TRUE)

Arguments

id

character vector with names or codes

unit

the type of European statistical unit to check

year

year of the analysis

matchWith

the type of id to check:

"name" if unit names
"code" if unit code
scale

the scale of the map.

return_logical

a logical value indicating whether nomatched id are returned.

print

a logical value indicating whether print the nomatched names

use_internet

a logical value indicating wheter the coordinates are downloaded from https://github.com/dataallaround/geospatial. If FALSE the maps downloaded during package installation will be used.

Details

The function provides a check between id name or code in the dataset and the corresponding selected United Kingdom statistical unit. unit starts from the largest aggregate, "country", to the smallest, "county". Since unit can change over the years, the year of the data has to be provided.

Value

Returns a string vector with nomatched names or a boolean vector indicating whether or not the id matched.

Author(s)

Alessio Serafini

See Also

checkNamesEU, checkNamesUS, checkNamesWR, checkNamesDE

Examples

data("popUK")
ck <- checkNamesUK(popUK$name, unit = "country")
str(ck)

mapping documentation built on Oct. 19, 2023, 5:06 p.m.