cvd_area_search: Search for matching areas

In cvdprevent: Wrapper for the 'CVD Prevent' Application Programming Interface

Search for matching areas

Description

Returns a list of Areas that match a partial name for a given time period. Uses simple LIKE '%<partial_area_name>%' comparison.

Usage

cvd_area_search(partial_area_name = "Surgery", time_period_id = 1)

Arguments

partial_area_name	string - string to use to search for an Area (compulsory)
time_period_id	integer - limits the search to Areas which have data in specified time period (compulsory)

Details

CVD Prevent API documentation: Area search

Value

Tibble of details for areas matching the search term

See Also

cvd_area_list(), cvd_area_details(), cvd_area_unassigned(), cvd_area_nested_subsystems(), cvd_area_flat_subsystems()

Examples

# NB, the following examples are not tested because they take longer than
# expected to return the results

# search for areas matching the term 'practice'
cvd_area_search(partial_area_name = 'practice', time_period_id = 17) |>
  dplyr::select(AreaID, AreaName, AreaCode)

# search for areas matching the term 'PCN'
cvd_area_search(partial_area_name = 'PCN', time_period_id = 17) |>
  dplyr::select(AreaID, AreaName, AreaCode)

cvdprevent documentation built on June 8, 2025, 10:16 a.m.