Skip to contents

Fetch GHO Data

Source: R/gho.R
gho_data.Rd

Retrieves observations for a specific indicator from the WHO GHO OData API, with optional filters by spatial level, country / region and year range.

Usage

gho_data(
  indicator,
  spatial_type = NULL,
  area = NULL,
  year_from = NULL,
  year_to = NULL
)

Arguments

indicator

Character scalar. The indicator code (e.g. "NCDMORT3070"). Use gho_indicators() to find codes.

spatial_type

Character. Spatial dimension to filter on: one of "country", "region", "global", or NULL (all levels, the default).

area

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

year_from

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

year_to

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

Value

A tibble of indicator observations, or an empty tibble when the service is unreachable.

See also

gho_indicators(), gho_dimensions().

Examples

# \donttest{
# Country-level data for one indicator
gho_data("NCDMORT3070", spatial_type = "country")
#> Fetching:
#> <https://ghoapi.azureedge.net/api/NCDMORT3070?$filter=SpatialDimType%20eq%20%27COUNTRY%27>
#> # A tibble: 12,210 × 25
#>        Id IndicatorCode SpatialDimType SpatialDim ParentLocationCode TimeDimType
#>     <int> <chr>         <chr>          <chr>      <chr>              <chr>      
#>  1 5.30e6 NCDMORT3070   COUNTRY        KHM        WPR                YEAR       
#>  2 5.30e6 NCDMORT3070   COUNTRY        ISL        EUR                YEAR       
#>  3 5.30e6 NCDMORT3070   COUNTRY        UZB        EUR                YEAR       
#>  4 5.30e6 NCDMORT3070   COUNTRY        GUY        AMR                YEAR       
#>  5 5.31e6 NCDMORT3070   COUNTRY        ISR        EUR                YEAR       
#>  6 5.31e6 NCDMORT3070   COUNTRY        CHN        WPR                YEAR       
#>  7 5.31e6 NCDMORT3070   COUNTRY        BGD        SEAR               YEAR       
#>  8 5.31e6 NCDMORT3070   COUNTRY        MLI        AFR                YEAR       
#>  9 5.31e6 NCDMORT3070   COUNTRY        FRA        EUR                YEAR       
#> 10 5.31e6 NCDMORT3070   COUNTRY        ITA        EUR                YEAR       
#> # ℹ 12,200 more rows
#> # ℹ 19 more variables: ParentLocation <chr>, Dim1Type <chr>, Dim1 <chr>,
#> #   TimeDim <int>, Dim2Type <chr>, Dim2 <chr>, Dim3Type <lgl>, Dim3 <lgl>,
#> #   DataSourceDimType <lgl>, DataSourceDim <lgl>, Value <chr>,
#> #   NumericValue <dbl>, Low <dbl>, High <dbl>, Comments <chr>, Date <chr>,
#> #   TimeDimensionValue <chr>, TimeDimensionBegin <chr>, TimeDimensionEnd <chr>

# Specific countries and years
gho_data("WHOSIS_000001", area = c("FRA", "DEU"), year_from = 2015)
#> Assuming `spatial_type` = "country" since `area` was given.
#> ℹ Pass `spatial_type` explicitly to silence this message.
#> Fetching:
#> <https://ghoapi.azureedge.net/api/WHOSIS_000001?$filter=SpatialDimType%20eq%20%27COUNTRY%27%20and%20SpatialDim%20in%20%28%27FRA%27%2C%27DEU%27%29%20and%20TimeDim%20ge%202015>
#> # A tibble: 42 × 25
#>        Id IndicatorCode SpatialDimType SpatialDim TimeDimType ParentLocationCode
#>     <int> <chr>         <chr>          <chr>      <chr>       <chr>             
#>  1 5.48e6 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#>  2 5.63e6 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#>  3 5.71e6 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#>  4 2.05e5 WHOSIS_000001 COUNTRY        DEU        YEAR        EUR               
#>  5 2.96e5 WHOSIS_000001 COUNTRY        DEU        YEAR        EUR               
#>  6 8.63e5 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#>  7 9.58e5 WHOSIS_000001 COUNTRY        DEU        YEAR        EUR               
#>  8 1.11e6 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#>  9 1.21e6 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#> 10 1.54e6 WHOSIS_000001 COUNTRY        FRA        YEAR        EUR               
#> # ℹ 32 more rows
#> # ℹ 19 more variables: ParentLocation <chr>, Dim1Type <chr>, Dim1 <chr>,
#> #   TimeDim <int>, Dim2Type <lgl>, Dim2 <lgl>, Dim3Type <lgl>, Dim3 <lgl>,
#> #   DataSourceDimType <lgl>, DataSourceDim <lgl>, Value <chr>,
#> #   NumericValue <dbl>, Low <dbl>, High <dbl>, Comments <lgl>, Date <chr>,
#> #   TimeDimensionValue <chr>, TimeDimensionBegin <chr>, TimeDimensionEnd <chr>
# }