Skip to contents

Browse available HMIS indicators with optional filtering by name pattern or minimum temporal coverage.

Usage

list_indicators(
  pattern = NULL,
  min_months = NULL,
  geography = c("state", "district"),
  match = c("fixed", "regex", "fuzzy")
)

Arguments

pattern

Optional string to filter indicator names (case-insensitive). Matching behavior depends on match.

min_months

Minimum number of year-months of data required. Default NULL (no filter).

geography

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

match

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

Value

A tibble with columns: canonical_name, n_yearmon, first_month, last_month.

Examples

# All state-level indicators
list_indicators()
#>  840 indicators found.
#> # A tibble: 840 × 4
#>    canonical_name                               n_yearmon first_month last_month
#>    <chr>                                            <dbl> <chr>       <chr>     
#>  1 Above 10 years to below 19 years                    24 Apr 2023    Mar 2025  
#>  2 Above 5 years to below 10 years                     24 Apr 2023    Mar 2025  
#>  3 Adult above >19 years                               24 Apr 2023    Mar 2025  
#>  4 Albendazole 400 mg tablet                           96 Apr 2017    Mar 2025  
#>  5 Amoxycillin (Paediatrics Antibiotics)               24 Apr 2023    Mar 2025  
#>  6 Antepartum (Macerated) Still Birth                  24 Apr 2023    Mar 2025  
#>  7 Average kilometres travelled by ALS during …        24 Apr 2023    Mar 2025  
#>  8 Average kilometres travelled by BLS during …        24 Apr 2023    Mar 2025  
#>  9 Average number of trips per day by ALS duri…        24 Apr 2023    Mar 2025  
#> 10 Average number of trips per day by BLS duri…        24 Apr 2023    Mar 2025  
#> # ℹ 830 more rows

# Search by keyword
list_indicators(pattern = "malaria")
#>  14 indicators found.
#> # A tibble: 14 × 4
#>    canonical_name                               n_yearmon first_month last_month
#>    <chr>                                            <dbl> <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 blood smears examined for Malaria        204 Apr 2008    Mar 2025  
#>  8 Number of cases of Adolescent or Adult deat…       108 Apr 2008    Mar 2017  
#>  9 Number of cases of Malaria reported in chil…       108 Apr 2008    Mar 2017  
#> 10 Number of Deaths due to Malaria - Plasmodiu…        96 Apr 2017    Mar 2025  
#> 11 Number of Deaths due to Malaria - Plasmodiu…        96 Apr 2017    Mar 2025  
#> 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  

# Names with special characters work without escaping
list_indicators(pattern = "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  

# Fuzzy matching for approximate names
list_indicators(pattern = "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  

# Only indicators with 100+ months of data
list_indicators(min_months = 100)
#>  224 indicators found.
#> # A tibble: 224 × 4
#>    canonical_name                               n_yearmon first_month last_month
#>    <chr>                                            <dbl> <chr>       <chr>     
#>  1 Deliveries conducted at Private Institution…       108 Apr 2008    Mar 2017  
#>  2 Deliveries conducted at Public Institutions…       204 Apr 2008    Mar 2025  
#>  3 In - Patient Head Count at midnight                204 Apr 2008    Mar 2025  
#>  4 No. of C - section deliveries performed at …       108 Apr 2008    Mar 2017  
#>  5 No. of Children aged 9 to 12 months who rec…       204 Apr 2008    Mar 2025  
#>  6 Number of Abortions (spontaneous or induced)       204 Apr 2008    Mar 2025  
#>  7 Number of Adolescents counselled                   204 Apr 2008    Mar 2025  
#>  8 Number of Anganwadi centres reported to hav…       108 Apr 2008    Mar 2017  
#>  9 Number of ASHAs paid JSY Incentive for deli…       108 Apr 2008    Mar 2017  
#> 10 Number of ASHAs paid JSY Incentive for deli…       108 Apr 2008    Mar 2017  
#> # ℹ 214 more rows

# District-level indicators
list_indicators(geography = "district")
#>  845 indicators found.
#> # A tibble: 845 × 4
#>    canonical_name                               n_yearmon first_month last_month
#>    <chr>                                            <int> <chr>       <chr>     
#>  1 Above 10 years to below 19 years                    24 Apr 2023    Mar 2025  
#>  2 Above 5 years to below 10 years                     24 Apr 2023    Mar 2025  
#>  3 Adult above >19 years                               24 Apr 2023    Mar 2025  
#>  4 Age wise total Maternal Deaths, occurred at…        24 Apr 2023    Mar 2025  
#>  5 Age wise total number of delivery (Home +In…        24 Apr 2023    Mar 2025  
#>  6 Albendazole 400 mg tablet                           96 Apr 2017    Mar 2025  
#>  7 Amoxycillin (Paediatrics Antibiotics)               24 Apr 2023    Mar 2025  
#>  8 Antepartum (Macerated) Still Birth                  24 Apr 2023    Mar 2025  
#>  9 Average kilometres travelled by all ALS Amb…        24 Apr 2023    Mar 2025  
#> 10 Average kilometres travelled by all BLS Amb…        24 Apr 2023    Mar 2025  
#> # ℹ 835 more rows