Pathway groups

Pathway groups are sub-groupings of Priority Groups, visible in the Regional & ICS Insights page. This endpoint returns a single pathway group for a given group ID. An error will be returned if there is no pathway group associated with the given ID. For a valid request, Pathway Group ID and named are returned as key value pairs and the Indicators populate an array.

Usage

cvd_indicator_pathway_group(pathway_group_id)

Arguments

pathway_group_id

integer - the pathway to return data for (compulsory)

Value

Tibble of indicators grouped by pathway groups

Details

CVD Prevent API documentation: Indicator pathway 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_group(), cvd_indicator_metric_timeseries(), cvd_indicator_person_timeseries(), cvd_indicator_metric_systemlevel_comparison(), cvd_indicator_metric_area_breakdown()

Examples

# Return indicators for the 'Chronic Kidney Disease' Pathway Group (ID 9):
cvd_indicator_pathway_group(pathway_group_id = 9) |>
  dplyr::select(PathwayGroupName, PathwayGroupID, IndicatorCode, IndicatorID, IndicatorName)
#> # A tibble: 6 × 5
#>   PathwayGroupName       PathwayGroupID IndicatorCode IndicatorID IndicatorName 
#>   <chr>                           <int> <chr>               <int> <chr>         
#> 1 Chronic Kidney Disease              9 CVDP002CKD             13 "Patients who…
#> 2 Chronic Kidney Disease              9 CVDP001CKD              8 "Prevalence o…
#> 3 Chronic Kidney Disease              9 CVDP006CKD             29 "Patients wit…
#> 4 Chronic Kidney Disease              9 CVDP005CKD             19 "Patients wit…
#> 5 Chronic Kidney Disease              9 CVDP007CKD             31 "Patients wit…
#> 6 Chronic Kidney Disease              9 CVDP010CHOL            23 "Patients wit…