Returns a single indicator group for a given group ID. An error will be
returned if there is no indicator group associated with the given ID.
IndicatorGroup is the primary key in the IndicatorGroup table, which also
contains IndicatorGroupName and IndicatorGroupTypeID. The group type ID
tells you what type of indicator group you're dealing with, e.g. a Priority
Group.
IndicatorGroupTypeID is the primary key of IndicatorGroupType and so
IndicatorGroupTypeName is the associated name for the given group type ID.
Finally, there is the array of indicators which are contained in this group,
including display orders for the given group.
Details
CVD Prevent API documentation: Indicator group
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_metric_timeseries(),
cvd_indicator_person_timeseries(), cvd_indicator_metric_systemlevel_comparison(),
cvd_indicator_metric_area_breakdown()
Examples
# list the indicators under Indicator Group ID 13 (Monitoring) which lists
# 'Key Question' Indicator Group indicators:
cvd_indicator_group(indicator_group_id = 13) |>
dplyr::select(IndicatorGroupID, IndicatorGroupName, IndicatorGroupTypeName,
IndicatorID, IndicatorName)
#> # A tibble: 2 × 5
#> IndicatorGroupID IndicatorGroupName IndicatorGroupTypeName IndicatorID
#> <int> <chr> <chr> <int>
#> 1 13 Monitoring Key Question 4
#> 2 13 Monitoring Key Question 29
#> # ℹ 1 more variable: IndicatorName <chr>