indicators: Live indicators and the profiles and domains they belong to

In ropensci/fingertipsR: Fingertips Data for Public Health

Live indicators and the profiles and domains they belong to

Description

Outputs a data frame of indicators within a profile or domain

Usage

indicators(
  ProfileID = NULL,
  DomainID = NULL,
  proxy_settings = fingertips_proxy_settings(),
  path
)

Arguments

ProfileID	Numeric vector, id of profiles of interest
DomainID	Numeric vector, id of domains of interest
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 indicators within a profile or domain.

See Also

area_types for area type and their parent mappings, indicator_metadata for indicator metadata, 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: area_types(), category_types(), deprivation_decile(), indicator_areatypes(), indicator_metadata(), indicator_order(), indicators_unique(), nearest_neighbours(), profiles()

Examples

## Not run: 
# Returns a complete data frame of indicators and their domains and profiles
indicators()

# Returns a data frame of all of the indicators in the Public Health Outcomes Framework
indicators(ProfileID = 19)
## End(Not run)

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