Indicator sibling data

Returns all sibling 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 a chosen indicator, hence the metric_id query parameter.

Usage

cvd_indicator_sibling(time_period_id, area_id, metric_id)

Arguments

time_period_id

integer - time period for which to return data (compulsory)

area_id

integer - area for which all sibling data will be returned (compulsory)

metric_id

integer - metric for which to return data (compulsory)

Value

Tibble of data for indicators for the area and its siblings in the time period

Details

CVD Prevent API documentation: Indicator sibling data

See also

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

cvd_indicator_sibling(time_period_id = 17, area_id = 1103, metric_id = 126) |>
  dplyr::select(AreaID, AreaName, Value, LowerConfidenceLimit, UpperConfidenceLimit)
#> # A tibble: 1 × 5
#>   AreaID AreaName      Value LowerConfidenceLimit UpperConfidenceLimit
#>    <int> <chr>         <dbl>                <dbl>                <dbl>
#> 1   1103 3 Centres PCN   100                 84.2                  100