Skip to contents

Search HMIS Indicators by Keyword

Source: R/indicators.R
search_indicators.Rd

Convenience wrapper around list_indicators() for substring search.

Usage

search_indicators(
  pattern,
  geography = c("state", "district"),
  match = c("fixed", "regex", "fuzzy")
)

Arguments

pattern

String to search indicator names (case-insensitive).

geography

One of "state" or "district". Default "state".

match

One of "fixed" (default, plain substring), "regex", or "fuzzy" (approximate matching).

Value

A tibble of matching indicators.

Examples

search_indicators("live birth")
#> ℹ 4 indicators found.
#> # A tibble: 4 × 4
#>   canonical_name                                n_yearmon first_month last_month
#>   <chr>                                             <dbl> <chr>       <chr>     
#> 1 Number of female live births                        204 Apr 2008    Mar 2025  
#> 2 Number of live births among Syphilis Seropos…        24 Apr 2023    Mar 2025  
#> 3 Number of male live births                          204 Apr 2008    Mar 2025  
#> 4 Total number of male and female live births …       108 Apr 2008    Mar 2017  
search_indicators("Malaria (Microscopy Tests)")
#> ℹ 3 indicators found.
#> # A tibble: 3 × 4
#>   canonical_name                                n_yearmon first_month last_month
#>   <chr>                                             <dbl> <chr>       <chr>     
#> 1 Malaria (Microscopy Tests) - Mixed test posi…        24 Apr 2023    Mar 2025  
#> 2 Malaria (Microscopy Tests) - Plasmodium Falc…        96 Apr 2017    Mar 2025  
#> 3 Malaria (Microscopy Tests) - Plasmodium Viva…        96 Apr 2017    Mar 2025  
search_indicators("malaria", geography = "district")
#> ℹ 14 indicators found.
#> # A tibble: 14 × 4
#>    canonical_name                               n_yearmon first_month last_month
#>    <chr>                                            <int> <chr>       <chr>     
#>  1 Childhood Diseases - Malaria                        96 Apr 2017    Mar 2025  
#>  2 Inpatient - Malaria                                 96 Apr 2017    Mar 2025  
#>  3 Malaria (Microscopy Tests) - Mixed test pos…        24 Apr 2023    Mar 2025  
#>  4 Malaria (Microscopy Tests) - Plasmodium Fal…        96 Apr 2017    Mar 2025  
#>  5 Malaria (Microscopy Tests) - Plasmodium Viv…        96 Apr 2017    Mar 2025  
#>  6 Malaria (RDT) - Plamodium Falciparum test p…        96 Apr 2017    Mar 2025  
#>  7 Number of Deaths due to Malaria - Plasmodiu…        96 Apr 2017    Mar 2025  
#>  8 Number of Deaths due to Malaria - Plasmodiu…        96 Apr 2017    Mar 2025  
#>  9 Number of blood smears examined for Malaria        204 Apr 2008    Mar 2025  
#> 10 Number of cases of Adolescent or Adult deat…       108 Apr 2008    Mar 2017  
#> 11 Number of cases of Malaria reported in chil…       108 Apr 2008    Mar 2017  
#> 12 Out of blood smears examined for malaria, n…       108 Apr 2008    Mar 2017  
#> 13 Out of blood smears examined for malaria, n…       108 Apr 2008    Mar 2017  
#> 14 RDT conducted for Malaria                           96 Apr 2017    Mar 2025  
search_indicators("Plsmodium Vivax", match = "fuzzy")
#> ℹ 3 indicators found.
#> # A tibble: 3 × 4
#>   canonical_name                                n_yearmon first_month last_month
#>   <chr>                                             <dbl> <chr>       <chr>     
#> 1 Malaria (Microscopy Tests) - Plasmodium Viva…        96 Apr 2017    Mar 2025  
#> 2 Number of Deaths due to Malaria - Plasmodium…        96 Apr 2017    Mar 2025  
#> 3 Out of blood smears examined for malaria, nu…       108 Apr 2008    Mar 2017