Outputs a data frame containing the metadata for selected indicators. Note, this function can take up to a few minutes to run (depending on internet connection speeds)
Usage
indicator_metadata(
IndicatorID = NULL,
DomainID = NULL,
ProfileID = NULL,
proxy_settings = fingertips_proxy_settings(),
path
)Arguments
- IndicatorID
Numeric vector, id of the indicator of interest. Also accepts "All".
- DomainID
Numeric vector, id of domains of interest
- ProfileID
Numeric vector, id of profiles of interest. Indicator polarity can vary between profiles therefore if using one of the comparison fields it is recommended to complete this field as well as IndicatorID. If IndicatorID is populated, ProfileID can be ignored or must be the same length as IndicatorID (but can contain NAs).
- 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
See also
indicators for indicator lookups,
profiles for profile lookups,
deprivation_decile for deprivation lookups,
area_types for area types and their parent mappings,
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_order(),
indicators(),
indicators_unique(),
nearest_neighbours(),
profiles()
Examples
if (FALSE) { # \dontrun{
# Returns metadata for indicator ID 90362 and 92901
indicatorIDs <- c(90362, 92901)
indicator_metadata(indicatorIDs)
# Returns metadata for the indicators within the domain 1000049
indicator_metadata(DomainID = 1000049)
# Returns metadata for the indicators within the profile with the ID 19
indicator_metadata(ProfileID = 19)} # }