Area details

Returns details of a specific area at a given time period, including details about any parent and child areas.

Usage

cvd_area_details(time_period_id, area_id)

Arguments

time_period_id

integer - specified time period for which to return details for, i.e. population and participation rate (compulsory)

area_id

integer - specified area id for which to return details for.

Value

Named list of tibbles containing area 'area_details', child 'area_child_details' (where appropriate) and parent 'area_parent_details' (where appropriate)

Details

CVD Prevent API documentation: Area details

See also

cvd_area_list(), cvd_area_unassigned(), cvd_area_search(), cvd_area_nested_subsystems(), cvd_area_flat_subsystems()

Examples

# to see details for 'Leicester, Leicestershire and Rutland ICB' (area_id = 8037) use the following:
# get the list of tibbles from the function
returned_list <- cvd_area_details(time_period_id = 17, area_id = 8037)

# view area details
returned_list$area_details |>
  dplyr::select(AreaCode, AreaName)
#> # A tibble: 1 × 2
#>   AreaCode  AreaName                                                       
#>   <chr>     <chr>                                                          
#> 1 E54000015 NHS Leicester, Leicestershire and Rutland Integrated Care Board

# view details for the parent of this area
returned_list$area_parent_details |>
  dplyr::select(AreaID, AreaName, SystemLevelID)
#> # A tibble: 1 × 3
#>   AreaID AreaName SystemLevelID
#>    <int> <chr>            <int>
#> 1   7922 Midlands             6

# view details for the children of this area
returned_list$area_child_details |>
  dplyr::select(AreaID, AreaName, SystemLevelID)
#> # A tibble: 3 × 3
#>   AreaID AreaName                                            SystemLevelID
#>    <int> <chr>                                                       <int>
#> 1   7994 NHS Leicester, Leicestershire and Rutland ICB - 03W             8
#> 2   8009 NHS Leicester, Leicestershire and Rutland ICB - 04C             8
#> 3   8014 NHS Leicester, Leicestershire and Rutland ICB - 04V             8