Skip to contents

Return lookup query URL and lower and higher field codes

Usage

return_lookup_query_info(
  lookup,
  within,
  lookup_year,
  within_year,
  country_filter,
  option,
  chatty
)

Arguments

lookup

character. Lower level area code eg "lsoa", "wd", "lad". Equivalent to the lookup parameter in bounds().

within

character. Higher level area code eg "lad", "cty". Equivalent to the within parameter in bounds().

lookup_year

numeric or character. A specific year for data relating to parameter x, if needed. Defaults to NULL, which will return the most recent data.

within_year

numeric or character. A specific year for data relating to parameter y, if needed. Defaults to NULL, which will return the most recent data.

country_filter

character. Open Geography datasets are sometimes available just within certain countries. Specify a country code if you want your results restricted to a certain country only - eg "WA" for Wales, "EW" for England and Wales. By default returns all options.

option

numeric. Defaults to 1, which means that the URL will just be the first one from the list of possible services resulting from the level and year filters above. If this does not give you what you want, you can run the script again with a different option from the list.

chatty

Boolean. Whether to print feedback on the 'decisions' the function has taken about which table to query. Default TRUE when the function is run in an interactive session, FALSE otherwise.

Value

A list of length 3: the query URL, the lower level (lookup) field code (eg lsoa11cd), and the higher level (within) field code.