cvd_indicator_child_data: Indicator child data

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

Indicator child data

Description

Returns all children areas and their data for specified time period, area and metric. This endpoint is intended to only return data for selected metric, and not all metrics for indicators, hence the metricID query parameter.

Usage

cvd_indicator_child_data(time_period_id = 17, area_id = 74, metric_id = 1)

Arguments

time_period_id	integer - time period for which to return data (compulsory)
area_id	integer - area for which all children data will be returned (compulsory)
metric_id	integer - metric for which to return data (compulsory)

Details

CVD Prevent API documentation: Indicator child data

Value

Tibble of details for the specified metric in the child areas of the specified area

See Also

cvd_indicator_list(), cvd_indicator_metric_list(), cvd_indicator(), cvd_indicator_tags(), cvd_indicator_details(), cvd_indicator_sibling(), 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

cvd_indicator_child_data(time_period_id = 17, area_id = 74, metric_id = 126) |>
  dplyr::select(AreaID, AreaName, Value, LowerConfidenceLimit, UpperConfidenceLimit)

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