Description Usage Arguments Value See Also Examples
View source: R/indicator_metadata.R
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)
1 | indicator_metadata(IndicatorID = NULL, DomainID = NULL, ProfileID = NULL, path)
|
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). |
path |
String; Fingertips API address. Function will default to the correct address |
The metadata associated with each indicator/domain/profile identified
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_unique()
,
indicators()
,
nearest_neighbours()
,
profiles()
1 2 3 4 5 6 7 8 9 10 11 | ## Not run:
# Returns metadata for indicator ID 90362 and 1107
indicatorIDs <- c(90362, 1107)
indicator_metadata(indicatorIDs)
# Returns metadata for the indicators within the domain 1000101
indicator_metadata(DomainID = 1000101)
# Returns metadata for the indicators within the profile with the ID 129
indicator_metadata(ProfileID = 129)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.