cvd_indicator_list {cvdprevent} | R Documentation |
List indicators
Description
Returns basic details of all indicators for a given system level and time period. Only returns indicators for which data exists in selected time period, and on selected system level. Used to populate available indicator list in Data Explorer.
Usage
cvd_indicator_list(time_period_id = 1, system_level_id = 2)
Arguments
time_period_id |
integer - time period to reutrn data for (compulsory) |
system_level_id |
integer - system level to return data for (compulsory) |
Details
CVD Prevent API documentation: Indicator list
Value
Tibble of details for indicators for the time period and system level
See Also
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()
,
cvd_indicator_metric_area_breakdown()
Examples
# List four indicators for time point 17 and GP practice level (system level 5)
cvd_indicator_list(time_period_id = 17, system_level_id = 5) |>
dplyr::select(IndicatorID, IndicatorCode, IndicatorShortName) |>
dplyr::slice_head(n = 4)