Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 2.81 KB

README.md

File metadata and controls

46 lines (31 loc) · 2.81 KB

R-CMD-check CodeFactor codecov

poliprep

What is poliprep?

poliprep is an R package developed by the polio data science team at The World Health Organisation Regional Office for Africa (WHO AFRO). It is designed to assist users who have access to and work with datasets collected as part of the Global Polio Eradication Initiative.

The package offers a number of functions for various tasks, including importing and exporting data, pulling data from relevant APIs, data processing and cleaning, as well as performing validations and checks. It also features the capability to generate reports or scorecards highlighting areas of concern identified during the validation process.

🔧 Installation

The package can be installed directly using devtools. The steps are as follows:

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

# 2) Install the poliprep package from GitHub
devtools::install_github("WorldHealthOrganization/poliprep")

🌐 Roadmap

We plan to add a number of functions which do the following:

  • Import and export different datasets (tabular, shapefiles, etc.).
  • Pull data from ONA using an API call.
  • Update data from ONA API without re-downloading.
  • Clean and fix names of places including geolocations.
  • Check and clean geo-coordinates.
  • Match variables naming conventions & datatypes within two dataframes.
  • Validate AFP & ES POLIS data.
  • Validate AFP Surveillance data.
  • Validate A Surveillance data.
  • Create New Detections Table from POLIS data.

📨 Contacting us

For any issues or questions about poliprep, please contact Mo at [email protected].

🤝 Guidance on making contributions

We welcome contributions via forking and pull requests. For guidance and best practices, please follow WHO's Contribution Guidelines. Additionally, before any contribution, please ensure you are familiar with WHO's Contributor Covenant Code of Conduct.