category_types: Category types

In ropensci/fingertipsR: Fingertips Data for Public Health

Category types

Description

Outputs a data frame of category type ids, their name (along with a short name)

Usage

category_types(proxy_settings = fingertips_proxy_settings(), path)

Arguments

proxy_settings	string; whether to use Internet Explorer proxy settings "default" or "none". Setting this manually will decrease runtime; default determined automatically.
path	String; Fingertips API address. Function will default to the correct address

Value

A data frame of category type ids and their descriptions

See Also

indicators for indicator lookups, profiles for profile lookups, deprivation_decile for deprivation decile lookups, area_types for area type 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: area_types(), deprivation_decile(), indicator_areatypes(), indicator_metadata(), indicator_order(), indicators_unique(), indicators(), nearest_neighbours(), profiles()

Examples

## Not run: 
# Returns the deprivation category types
cats <- category_types()
cats[cats$CategoryTypeId == 1,]
## End(Not run)

ropensci/fingertipsR documentation built on Feb. 27, 2024, 7:33 a.m.