Metric data

Returns all metric data for a specified metric. Data will include values for both selected area and organisation at National Level (usually England).

Usage

cvd_indicator_metric_data(metric_id, time_period_id, area_id)

Arguments

metric_id

integer - metric for which to return data for (compulsory)

time_period_id

integer - time period for which to return data for (compulsory)

area_id

integer - area for which to return data for (compulsory)

Value

Tibble of details for metric performance in the area and time period

Details

CVD Prevent API documentation: Indicator metric data

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_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(), cvd_indicator_metric_area_breakdown()

Examples

# Retrieve metric data for AF: treatment with anticoagulants for 'Alliance
# PCN' (area ID 399) in time period 1 for metric 126 (breakdown by age group:
# males aged 40-59):
cvd_indicator_metric_data(metric_id = 126, time_period_id = 1, area_id = 399) |>
  dplyr::select(IndicatorShortName, CategoryAttribute, MetricCategoryName,
  AreaData.Value, NationalData.Value)
#> # A tibble: 1 × 5
#>   IndicatorShortName         CategoryAttribute MetricCategoryName AreaData.Value
#>   <chr>                      <chr>             <chr>              <lgl>         
#> 1 AF: Treated with anticoag… Male              40-59              NA            
#> # ℹ 1 more variable: NationalData.Value <dbl>