cvd_area_details {cvdprevent} | R Documentation |
Area details
Description
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 = 1, area_id = 1)
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. |
Details
CVD Prevent API documentation: Area details
Value
Named list of tibbles containing area 'area_details', child 'area_child_details' (where appropriate) and parent 'area_parent_details' (where appropriate)
See Also
cvd_area_list()
, cvd_area_unassigned()
, cvd_area_search()
, cvd_area_nested_subsystems()
, cvd_area_flat_subsystems()
Examples
# to see details for '3 Centres PCN' (area_id = 1103) use the following:
# get the list of tibbles from the function
returned_list <- cvd_area_details(time_period_id = 17, area_id = 1103)
# view area details
returned_list$area_details |>
dplyr::select(AreaCode, AreaName)
# view details for the parent of this area
returned_list$area_parent_details |>
dplyr::select(AreaID, AreaName, SystemLevelID)
# view details for the children of this area
returned_list$area_child_details |>
dplyr::select(AreaID, AreaName, SystemLevelID)
[Package cvdprevent version 0.2.2 Index]