Skip to contents

Summarise Per-Location Data Coverage of a GHO Indicator

Source: R/gho.R
gho_coverage.Rd

Fetches only the SpatialDim and TimeDim columns for a GHO indicator (much lighter than gho_data()) and summarises the year range and observation count per location. Useful for answering "which countries have data, and for what years?" before committing to a full download.

Usage

gho_coverage(
  indicator,
  spatial_type = "country",
  area = NULL,
  year_from = NULL,
  year_to = NULL
)

Arguments

indicator

Character scalar. The indicator code (e.g. "WHOSIS_000001").

spatial_type

Character. Spatial dimension to filter on: one of "country", "region", "global". Defaults to "country" since per-country coverage is the typical use case. Pass NULL for all spatial levels.

area

Character vector of country or region codes (e.g. c("FRA", "DEU")). Default NULL returns all areas for the chosen spatial_type.

year_from

Numeric. Start year filter (inclusive). Default NULL.

year_to

Numeric. End year filter (inclusive). Default NULL.

Value

A tibble with one row per location and columns:

  • location (chr) — the SpatialDim value (typically ISO3).

  • year_min (int) — earliest year with data.

  • year_max (int) — latest year with data.

  • n_obs (int) — number of observations.

    Sorted by location. Empty input or service failure returns an empty tibble with the same four columns.

See also

gho_data(), gho_has_data(), gho_count().

Examples

# \donttest{
# Year coverage of life expectancy for three countries
gho_coverage("WHOSIS_000001", area = c("FRA", "DEU", "JPN"))
#> Fetching:
#> <https://ghoapi.azureedge.net/api/WHOSIS_000001?$filter=SpatialDimType%20eq%20%27COUNTRY%27%20and%20SpatialDim%20in%20%28%27FRA%27%2C%27DEU%27%2C%27JPN%27%29&$select=SpatialDim,TimeDim>
#> # A tibble: 3 × 4
#>   location year_min year_max n_obs
#>   <chr>       <int>    <int> <int>
#> 1 DEU          2000     2021    66
#> 2 FRA          2000     2021    66
#> 3 JPN          2000     2021    66

# All countries with any life-expectancy data, since 2010
gho_coverage("WHOSIS_000001", year_from = 2010)
#> Fetching:
#> <https://ghoapi.azureedge.net/api/WHOSIS_000001?$filter=SpatialDimType%20eq%20%27COUNTRY%27%20and%20TimeDim%20ge%202010&$select=SpatialDim,TimeDim>
#> # A tibble: 185 × 4
#>    location year_min year_max n_obs
#>    <chr>       <int>    <int> <int>
#>  1 AFG          2010     2021    36
#>  2 AGO          2010     2021    36
#>  3 ALB          2010     2021    36
#>  4 ARE          2010     2021    36
#>  5 ARG          2010     2021    36
#>  6 ARM          2010     2021    36
#>  7 ATG          2010     2021    36
#>  8 AUS          2010     2021    36
#>  9 AUT          2010     2021    36
#> 10 AZE          2010     2021    36
#> # ℹ 175 more rows
# }