Skip to contents

🌐 Lea esto en español

immunABC is an R package aimed at immunization (A)nalyses (B)eyond (C)overage. It is the R implementation of the indicators proposed in PAHO’s manual Análisis más allá de la cobertura: Indicadores de desempeño del Programa Ampliado de Inmunización basados en datos del registro nominal de vacunación electrónico (currently available in Spanish only).

immunABC aims to support the Pan American Health Organization’s (PAHO) Comprehensive Immunization Unit (CIM) mission by providing advanced data analysis tools for immunization programs in the Americas. Specifically, it facilitates the calculation of innovative indicators beyond basic coverage, supports evidence-based decision-making through in-depth data exploration and visualization, and contributes to strengthening data capabilities within immunization programs by empowering human resources to effectively leverage their data.

To learn more about PAHO’s work on immunization, visit the PAHO Immunization site.

For documentation and vignettes for this R package, see: https://im-data-paho.github.io/immunabc.

Installation

# Install from GitHub
devtools::install_github("IM-Data-PAHO/immunabc")

Usage

Currently, immunABC contains eight main modules, grouped as in the manual into data quality (CD) and data usage (UD) indicators. The code beside each module (for example, CD 3.1) is the code of the indicator it implements in the manual. Follow the links below to explore detailed vignettes with practical examples and guidance on how to use each module:

Data quality (CD)

  1. CD 3.1/3.3 Date Consistency Comparison
    Identifies and quantifies logical inconsistencies between any two date variables in the EIR (e.g., vaccination date before date of birth). Helps detect data entry errors and record linkage issues before downstream analyses.

  2. CD 3.2 Dose Sequence Comparison
    Evaluates, person by person, whether the doses of an ordered sequence (e.g., DTP1, DTP2 and DTP3) are registered consistently in the EIR: a sequence is consistent only when no earlier dose is skipped and the doses were administered in chronological order. Helps detect doses registered with the wrong dose number, unregistered doses and record linkage issues.

  3. CD 5.2 Duplicate Doses
    Detects doses registered more than once for the same person in the EIR, telling apart duplicate records (the same vaccination event registered more than once, with the same date and place) from repeated records (the same dose registered on a different date or in a different place). Helps clean the EIR before coverage, dropout and other analyses that rely on dose counts.

Data usage (UD)

  1. UD 2.3 Birth Cohort Coverage
    Lets users track and visualize vaccination status among a specific cohort of newborns. Helps evaluate population-level protection against vaccine-preventable diseases.

  2. UD 2.4 Complete Schedule Coverage
    Evaluates whether individuals have received all required doses in a national immunization schedule (for a specific cohort up to a specified age). This module differs from standard coverage calculation as it evaluates each individual’s compliance with the national immunization schedule.

  3. UD 2.5 Vaccination Timeliness
    Analyzes the vaccination timeliness of the population, that is, the time that elapses between the age of eligibility for each dose and its administration, using nominal data from the electronic immunization registry. Vaccinating on time, and not only completing the schedule, is key to protecting each individual before they reach the period of highest risk for the disease. Furthermore, analyzing vaccination timeliness allows us to understand coverage and its impact on the epidemiology of the disease, monitor the vaccine supply chain, investigate access problems or vaccination willingness in certain communities and, through actions at different levels, prevent future dropouts.

  4. UD 2.7 Nominal Dropout Rate
    Calculates dropout rates between any two vaccine doses using nominal data. This module ensures accurate follow-up tracking across a vaccination schedule.

Others

  • Residence vs. Occurrence Analyses
    This module is currently not included in the manual but remains useful when dealing with data from EIRs. It includes functions for comparing vaccination coverage and dose distribution based on where people live versus where they were vaccinated. It helps identify population movement and service coverage gaps across geographic areas.

  • Example Datasets
    Each module works seamlessly with the example datasets provided in the package. These examples make it easy to test out the functionality and serve as a reference when preparing your own data.

Note

You can explore all the available vignettes by clicking on the Guides button in the navigation bar.

Contribute

We welcome suggestions, bug reports, and feature requests through the GitHub Issues page. If you’d like to contribute code or fixes, feel free to open a pull request.