fingertipsR (version 0.1.0)

fingertips_data: Fingertips data

Description

Outputs a data frame of data from Fingertips

Usage

fingertips_data(IndicatorID = NULL, AreaCode = NULL, DomainID = NULL,
  ProfileID = NULL, AreaTypeID = 102, ParentAreaTypeID = NULL,
  inequalities = FALSE)

Arguments

IndicatorID

Numeric vector, id of the indicator of interest

AreaCode

Character vector, ONS area code of area of interest

DomainID

Numeric vector, id of domains of interest

ProfileID

Numeric vector, id of profiles of interest

AreaTypeID

Numeric vector, the Fingertips ID for the area type; default is NULL

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

inequalities

TRUE or FALSE, determines whether the final table includes inequalities data where it exists. Default to FALSE

Value

A data frame of data extracted from the Fingertips API

Examples

# NOT RUN {
# Returns data for the two selected domains at county and unitary authority geography
doms <- c(1000049,1938132983)
fingdata <- fingertips_data(DomainID = doms)#'

# Returns data at local authority district geography for the indicator with the id 22401
fingdata <- fingertips_data(22401, AreaTypeID = 101)
# }