indicator_order: Indicator order number

In fingertipsR: Fingertips Data for Public Health

Description

Outputs a tibble of indicator ids and their sequence number for the provided domain and area type. This enables the user to order the indicators as they are ordered on the Fingertips website.

Usage

indicator_order(DomainID, AreaTypeID, ParentAreaTypeID, path)

Arguments

DomainID	Numeric vector, id of domains of interest
AreaTypeID	Numeric vector, the Fingertips ID for the area type. This argument accepts "All", which returns data for all available area types for the indicator(s), though this can take a long time to run
ParentAreaTypeID	Numeric vector, the comparator area type for the data extracted; if NULL the function will use the first record for the specified 'AreaTypeID' from the area_types() function
path	String; Fingertips API address. Function will default to the correct address

Value

A data frame of indicator ids and sequence number

See Also

indicators for indicators and their parent domains and profiles, 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 and nearest_neighbours for a vector of nearest neighbours for an area

Other lookup functions: area_types(), category_types(), deprivation_decile(), indicator_areatypes(), indicator_metadata(), indicators_unique(), indicators(), nearest_neighbours(), profiles()

Examples

## Not run: 
indicator_order(DomainID = 1938133161, AreaTypeID = 102, ParentAreaTypeID = 6)
## End(Not run)

fingertipsR documentation built on Sept. 16, 2020, 5:07 p.m.