cvd_indicator_metric_timeseries: Indicator time series by metric

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

Indicator time series by metric

Description

Returns data for the time series chart for specified metric ID and area ID. Contains an array of two areas in Areas, one of which is the National data with the other corresponding to the provided area ID. TargetValue is also returned in the Data dictionary.

Usage

cvd_indicator_metric_timeseries(metric_id = 1, area_id = 50)

Arguments

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

Details

CVD Prevent API documentation: Indicator time series metrics

Value

Tibble of time-series data for the specified metric in the area

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

Examples

# List data for Salford South East PCN (area ID 705) for 'AF: treatment with
# anticoagulants' for women people aged 60-79 years (metric ID 130):
cvd_indicator_metric_timeseries(metric_id = 130, area_id = 705) |>
  dplyr::select(AreaName, TimePeriodName, TimePeriodID, Value) |>
  tidyr::pivot_wider(
    names_from = AreaName,
    values_from = Value
  )

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