cvd_indicator_metric_list {cvdprevent} | R Documentation |
List metrics for indicators
Description
Returns same data as cvd_indicator_list() but adds a 'MetricList' array for each indicator, containing details of the relevant metrics. Only returns indicators for which data exists in selected time period, and on selected system level.
Usage
cvd_indicator_metric_list(time_period_id = 1, system_level_id = 1)
Arguments
time_period_id |
integer - time period to return data for (compulsory) |
system_level_id |
integer - system level to return data for (compulsory) |
Details
CVD Prevent API documentation: Indicator metric list
Value
Tibble of details for indicators and associated metrics
See Also
cvd_indicator_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()
,
cvd_indicator_metric_area_breakdown()
Examples
# List metrics for the prevalence of atrial fibrillation (indicator ID 1),
# focussing on just those metrics for the 40-59 years age group:
cvd_indicator_metric_list(time_period_id = 17, system_level_id = 1) |>
dplyr::filter(IndicatorID == 1, MetricCategoryName == '40-59') |>
dplyr::count(IndicatorID, IndicatorShortName, MetricID, MetricCategoryName, CategoryAttribute) |>
dplyr::select(-n)