area_types: Area types

In fingertipsR: Fingertips Data for Public Health

Description

Outputs a data frame of area type ids, their descriptions, and how they map to parent area types. To understand more on mappings of areas, see the Where to start section of the Life Expectancy vignette.

Usage

area_types(AreaTypeName = NULL, AreaTypeID = NULL, ProfileID = NULL, path)

Arguments

AreaTypeName	Character vector, description of the area type; default is NULL
AreaTypeID	Numeric vector, the Fingertips ID for the area type; default is NULL
ProfileID	Numeric vector, id of profiles of interest
path	String; Fingertips API address. Function will default to the correct address

Value

A data frame of area type ids and their descriptions

See Also

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

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

Examples

## Not run: 
# Returns a data frame with all levels of area and how they map to one another
area_types()

# Returns a data frame of county and unitary authority mappings
 area_types("counties")

# Returns a data frame of both counties, district
# and unitary authorities and their respective mappings
areas <- c("counties","district")
area_types(areas)

# Uses AreaTypeID to filter area types
area_types(AreaTypeID = 152)
## End(Not run)

fingertipsR documentation built on Sept. 16, 2020, 5:07 p.m.