fingertipsR (version 1.0.5)

nearest_neighbours: Nearest neighbours

Description

Outputs a character vector of similar areas for given area. Currently returns similar areas for Clinical Commissioning Groups (old and new) based on NHS England's similar CCG explorer tool or lower and upper tier local authorities based on CIPFA's Nearest Neighbours Model or upper tier local authorities based on Children's services statistical neighbour benchmarking tool

Usage

nearest_neighbours(AreaCode, AreaTypeID = 101, measure, path)

Arguments

AreaCode

Character vector, ONS area code of area of interest

AreaTypeID

AreaTypeID of the nearest neighbours (see area_types) for IDs. Only returns information on AreaTypeIDs 101, 102, 201, 202, 152, 153 and 154

measure

string; when AreaTypeID = 102 measure must be either "CIPFA" for CIPFA local authority nearest neighbours or "CSSN" for Children's services statistical neighbours

path

String; Fingertips API address. Function will default to the correct address

Value

A character vector of area codes

Details

Use AreaTypeID = 102 for the AreaTypeID related to Children's services statistical neighbours

See Also

indicators for indicator lookups, profiles for profile lookups, deprivation_decile for deprivation decile lookups, area_types for area type lookups, category_types for category type lookups, indicators_unique for unique indicatorids and their names, indicator_areatypes for indicators by area types lookups and indicator_order for the order indicators are presented on the Fingertips website within a Domain

Other lookup functions: area_types(), category_types(), deprivation_decile(), indicator_areatypes(), indicator_metadata(), indicator_order(), indicators_unique(), indicators(), profiles()

Examples

# NOT RUN {
nearest_neighbours(AreaCode = "E38000002", AreaTypeID = 154)
# }