cvd_indicator_person_timeseries: Indicator persons time series by indicator

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

Indicator persons time series by indicator

Description

Returns data for the Inequalities Markers Time Series chart for the provided indicator ID and area ID. Data contains information about the chosen target value as well as an array InequalityMarkers which contains all the time series data grouped into metric category types e.g. age group, ethnicity, etc.

Usage

cvd_indicator_person_timeseries(indicator_id = 1, area_id = 1)

Arguments

indicator_id	integer - the indicator to return data for (compulsory)
area_id	integer - the area to return data for (compulsory)

Details

CVD Prevent API documentation: Indicator person time series

Value

Tibble of metric performance for the specified indicator 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_metric_timeseries(), cvd_indicator_metric_systemlevel_comparison(), cvd_indicator_metric_area_breakdown()

Examples

# View the details of the time-series performance for indicator 'AF:
# treatment with anticoagulants' (ID 7) in Salford South East PCN (area ID
# 705), focussed just on the age group inequalities metrics:
cvd_indicator_person_timeseries(indicator_id = 7, area_id = 705) |>
  dplyr::filter(
    MetricCategoryTypeName == 'Age group',
    !is.na(Value)
  ) |>
  dplyr::select(MetricCategoryName, TimePeriodName, TimePeriodID, Value) |>
  tidyr::pivot_wider(
    names_from = MetricCategoryName,
    values_from = Value
  )

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