Skip to contents

List the bundled hex variables available for the PTI pipeline

list_hex_vars.Rd

Returns a tibble summarising every variable declared in the bundled `inst/hex_vars_registry.yaml`. Call this at the top of Step 4 to browse what indicators a deployer can pull from the registry without leaving R. The output is the entry point that decides what to pass to [use_hex_vars()].

Usage

list_hex_vars()

Value

A tibble with one row per (source, canonical name). Columns: `source_id`, `source_label`, `canonical_name`, `var_name`, `var_units`, `time_col`, `available_years` (a list-column), `weight`, `fun`, `is_population` (logical, `TRUE` for the registry-declared population variable).

Details

When the same canonical name appears in multiple sources, the tibble shows one row per (source, canonical name) pair so the deployer can pick the source they want; [use_hex_vars()] will then disambiguate via a `__<source-label>` suffix on the `canonical_name` column.

See also

[use_hex_vars()] to resolve specific variables; [get_available_years()] to query the live parquet for ground truth on temporal coverage.

Other data-input: aggregate_hex_to_shapes(), build_hex_metadata(), fct_template_reader(), fetch_hex_data(), get_available_years(), get_shape(), make_admin_lookup(), make_hex_grid(), pti_patch_admin_sheet(), use_hex_vars()

Examples

list_hex_vars()
#> # A tibble: 27 × 10
#>    source_id          source_label    canonical_name var_name var_units time_col
#>    <chr>              <chr>           <chr>          <chr>    <chr>     <chr>   
#>  1 wb_flood_exposure  WB Space2Stats… population     Populat… count     NA      
#>  2 wb_flood_exposure  WB Space2Stats… flood_exposur… Flood E… count     NA      
#>  3 wb_space2stats_api WB Space2Stats… fires_density  Fire De… fires/km2 NA      
#>  4 wb_space2stats_api WB Space2Stats… cyclone_frequ… Cyclone… events/y… NA      
#>  5 wb_space2stats_api WB Space2Stats… landslide_sus… Landsli… index     NA      
#>  6 wb_space2stats_api WB Space2Stats… drought_spei   Drought… SPEI ind… NA      
#>  7 wb_space2stats_api WB Space2Stats… pop_total      Populat… count     NA      
#>  8 wb_space2stats_api WB Space2Stats… pop_female_20… Female … count     NA      
#>  9 wb_space2stats_api WB Space2Stats… pop_male_2025  Male Po… count     NA      
#> 10 wb_space2stats_api WB Space2Stats… ghs_total_cou… Total U… cells     NA      
#> # ℹ 17 more rows
#> # ℹ 4 more variables: available_years <list>, weight <chr>, fun <chr>,
#> #   is_population <lgl>