Skip to contents

List Dimensions of a GHO Indicator

Source: R/gho.R
gho_dimensions.Rd

Returns the unique values of a given dimension across all observations of a GHO indicator. Useful for discovering which ages, sexes, regions, or other breakdowns are available before calling gho_data().

Usage

gho_dimensions(indicator, dimension = "SpatialDimType")

Arguments

indicator

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

dimension

Character. Name of the dimension column in the indicator data. Common values include "SpatialDim", "SpatialDimType", "TimeDim", "Dim1", "Dim2", and "Dim3". Case-sensitive (it is sent to the server as an OData $select field name). Default "SpatialDimType".

Value

A character vector of unique, sorted dimension values, or an empty character vector when the service is unreachable or the dimension is missing.

Details

Only the requested column is downloaded (via the OData $select query option), so this is a lightweight metadata query even for indicators with hundreds of thousands of observations. A dimension that is not a column of the GHO data table (e.g. a misspelling) makes the server reject the request; the failure surfaces as a warning and an empty character vector.

See also

gho_data(), gho_indicators().

Examples

# \donttest{
gho_dimensions("NCDMORT3070")
#> Fetching: <https://ghoapi.azureedge.net/api/NCDMORT3070?$select=SpatialDimType>
#> [1] "COUNTRY"              "GLOBAL"               "REGION"              
#> [4] "WORLDBANKINCOMEGROUP"
gho_dimensions("NCDMORT3070", dimension = "Dim1")
#> Fetching: <https://ghoapi.azureedge.net/api/NCDMORT3070?$select=Dim1>
#> Waiting 2s for retry backoff ■■■■■■■■■■■■■■■                 
#> Waiting 2s for retry backoff ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■  
#> [1] "SEX_BTSX" "SEX_FMLE" "SEX_MLE" 
# }