get_authorities: Get local authorities

In helen-food/fhrsdata: Returns Data from the FHRS API

Description

Fetches the list of authorities in the FHRS

Usage

get_authorities(country = NULL)

Arguments

country

The country that the authority is located within, as a character string: "England", "Wales", "Scotland" or "Northern Ireland".

Details

'get_authorities' makes an API call that returns the authorities that submit data to the FHRS scheme, and their ID, which can be used to filter other API calls. It takes an optional country parameter.

Value

A tibble of authorities and their code, the number of establishments they have, and for England or all authorities, their region.

Examples

# Get all authorities in the FHRS
get_authorities()

# Get all authorities in the FHRS in Scotland
get_authorities("Scotland")

helen-food/fhrsdata documentation built on Aug. 21, 2019, 12:22 p.m.