indicator_areatypes: Area types by indicator

View source: R/area_types.R

indicator_areatypesR Documentation

Area types by indicator

Description

Outputs a data frame of indicator ids and the area type ids that exist for that indicator

Usage

indicator_areatypes(
  IndicatorID,
  AreaTypeID,
  proxy_settings = fingertips_proxy_settings(),
  path
)

Arguments

IndicatorID

integer; the Indicator ID (can be ignored or of length 1). Takes priority over AreaTypeID if both are entered

AreaTypeID

integer; the Area Type ID (can be ignored or of length 1)

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 indicator ids and area type ids

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, 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(), category_types(), deprivation_decile(), indicator_metadata(), indicator_order(), indicators_unique(), indicators(), nearest_neighbours(), profiles()

Examples

## Not run: 
indicator_areatypes(IndicatorID = 10101)
## End(Not run)

PublicHealthEngland/fingertipsR documentation built on Feb. 23, 2024, 3:13 a.m.