Skip to contents

Area nested sub systems

Source: R/cvd_api_functions.R
cvd_area_nested_subsystems.Rd

Returns given area and children areas in a nested structure

Usage

cvd_area_nested_subsystems(area_id = 5)

Arguments

area_id

integer - the area to return data for (compulsory)

Value

List of named tibbles containing details for the area and each sub-level areas

Details

CVD Prevent API documentation: Area nested subsystems

See also

cvd_area_list(), cvd_area_details(), cvd_area_unassigned(), cvd_area_search(), cvd_area_flat_subsystems()

Examples

# View details for for Somerset STP
returned_list <- cvd_area_nested_subsystems(area_id = 5)
returned_list |> summary()
#>         Length Class  Mode
#> level_1 7      tbl_df list
#> level_2 7      tbl_df list
#> level_3 7      tbl_df list
#> level_4 7      tbl_df list

# see details for five of the immediate children of Somerset STP
returned_list$level_2 |>
  dplyr::slice_head(n = 5)
#> # A tibble: 1 × 7
#>   AreaCode  AreaID AreaName         AreaOdsCode ParentAreaID SystemLevelID
#>   <chr>      <int> <chr>            <chr>              <int>         <int>
#> 1 E38000150    105 NHS Somerset CCG 11X                    5             3
#> # ℹ 1 more variable: SystemLevelName <chr>

# View details for Leicester Central PCN
returned_list <- cvd_area_nested_subsystems(area_id = 701)
returned_list |> summary()
#>         Length Class  Mode
#> level_1 6      tbl_df list
#> level_2 7      tbl_df list

# see details for the GP practice children of the PCN
returned_list$level_2
#> # A tibble: 5 × 7
#>   AreaCode AreaID AreaName                AreaOdsCode ParentAreaID SystemLevelID
#>   <chr>     <int> <chr>                   <lgl>              <int>         <int>
#> 1 C82642     2278 Highfields Medical Cen… NA                   701             5
#> 2 C82643     2279 Community Health Centr… NA                   701             5
#> 3 Y02469     6621 Heron Gp Practice       NA                   701             5
#> 4 Y02686     6653 Bowling Green Street S… NA                   701             5
#> 5 C82080     7323 SHEFA MEDICAL PRACTICE  NA                   701             5
#> # ℹ 1 more variable: SystemLevelName <chr>