cvd_indicator_metric_area_breakdown: Indicator metric area breakdown

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

Indicator metric area breakdown

Description

Returns data for the Area Breakdown chart for provided metric, area and time period. Data contains the target value as well as an array SystemLevels which contains data grouped by system level.

Usage

cvd_indicator_metric_area_breakdown(
  metric_id = 1,
  time_period_id = 1,
  area_id = 1
)

Arguments

metric_id	integer - the metric to return data for (compulsory)
time_period_id	integer - the time period to return data for (compulsory)
area_id	integer - the area to return data for (compulsory)

Details

CVD Prevent API documentation: Indicator metric area breakdown

Value

Tibble of metric performance for the specified area compared with National level

See Also

cvd_indicator_list(), cvd_indicator_metric_list(), cvd_indicator(), cvd_indicator_tags(), cvd_indicator_details(), cvd_indicator_sibling(), cvd_indicator_child_data(), cvd_indicator_data(), cvd_indicator_metric_data(), cvd_indicator_raw_data(), cvd_indicator_nationalarea_metric_data(), cvd_indicator_priority_groups(), cvd_indicator_pathway_group(), # cvd_indicator_group(), cvd_indicator_metric_timeseries(), cvd_indicator_person_timeseries(), cvd_indicator_metric_systemlevel_comparison()

Examples

# Return performance for metric 'AF: DOAC & VitK' in men aged 60-79 years
# (metric ID 128) in time period 17 for Salford South East PCN (area ID 705):
cvd_indicator_metric_area_breakdown(metric_id = 128, time_period_id = 17,
  area_id = 705) |>
  dplyr::select(SystemLevelName, AreaID, AreaName, Value)

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