polisapi

Overview

This R package designed to simplify the process of downloading data from the Polio Information System (POLIS) database through an API, which is part of the World Health Organization (WHO) and is dedicated to supporting the Global Polio Eradication Initiative (GPEI). POLIS serves as a global repository for Polio-related information, including cases and vaccination campaigns across the remaining infected and endemic countries.

Installation

Install the package directly using devtools.

# Install devtools if you haven't already
install.packages("devtools")

# Install the POLIS API Downloader package from GitHub
devtools::install_github("truenomad/polisapi")

Access and Authentication

Before using the package, individuals need to be granted access by the POLIS team and provided with an access token. It's advisable to securely save your access token in the R environment, enhancing security and facilitating easy access across R scripts and sessions.

# Load the POLIS API Downloader package
library(polisapi)

# Set your access token securely in the R environment
usethis::edit_r_environ()
# Add the following line to your .Renviron file:
# POLIS_ACCESS_TOKEN = "your_access_token"

# Set up your token as object to use later
my_token = Sys.getenv("POLIS_ACCESS_TOKEN")

Usage

The package offers two primary methods for POLIS API interaction:

1. Direct Data Retrieval: get_polis_api_data

Retrieve data directly from the POLIS API for immediate analysis.

• Suitable for complete data downloads (each time).
• Good for complete downloads if using snaphots.
• Offers detailed control over data retrieval parameters.
• Has functionality to log file downloads.

Usage Example

# Fetch case data for a specific period and region
data <- get_polis_api_data(
  min_date = "2021-01-01",    
  max_date = "2021-01-31",
  data_type = "cases",
  region = 'AFRO', 
  select_vars = NULL,
  polis_api_key = my_token,
  log_results = TRUE,
  log_file_path = "my_log_path/polis_log.rds"
)

2. Data Updates: update_polis_api_data

Use this for periodic data updates, minimizing redundant retrievals.

• Checks for existing data and fetches new records.
• Good when you need to quickly update your polis data.
• Features built-in logging for update tracking.

Usage Example

# Periodically update case data for a specific period and region
update_polis_api_data(
  min_date = "2021-01-01",    
  max_date = Sys.Date(),
  data_type = "cases",
  region = 'AFRO',
  select_vars = NULL,
  file_path = my_path_to_save_data,
  save_directly = TRUE,
  log_results = TRUE,
  polis_api_key = my_token
)

Data Types

The POLIS API provides diverse datasets for download:

• Cases Data ("cases"): Detailed polioviruses cases data.
• Virus Data ("virus"): Virus are all data related with Viruses.
• Population Data ("population"): Data on all references population used in POLIS.
• Environmental Data ("env"): Data on all environmental samples collected.
• Geographical Data ("geo"): All references places used in POLIS.
• Geographical Synonym Data ("geo_synonym"): Alternate location names.
• Activity Data ("activity"): Information all SIA actions taken.
• Sub-activities Data ("sub_activ"): Details on specific SIA sub-activities taken.
• Lot Quality Assurance Sampling Data ("lqas"): Datasets on the quality of vaccination campaigns.
• Independent Monitoring Data ("im"): Datasets on the quality after vaccination campaigns.
• Lab Specimen Data (Human & Viruses) ("lab_specimen" & "lab_specimen_virus"): Details on human specimens and viruses; all specimens sent to laboratories to be investigated