README.md

In dark-peak-analytics/who_decide_AP: R Package to facilitate easy access to geospatial model data

WHO DECIDE Analytical Platform

This R package facilitates easy access to several APIs that host data relevant for decision modelling. It was created to enable users to quickly identify and download the data they need. Full package documentation can be found in the pdf within this folder.

Project Structure 
------------------------
    ├── .github            <- For use by GitHub
    │   └── workflows      <- workflows instructing GitHub Actions
    │
    ├── R                  <- R functions
    │
    ├── inst               <- Files copied unmodified into package, examples.
    |
    ├── Meta               <- Meta information - most can ignore this.
    |
    ├── man                <- ignore these, Rd files.
    │
    ├── tests              <- Unit tests using testthat to ensure code undertaken as intended
    │
    ├── vignettes          <- Vignettes describing package functionality
    │
    ├── bolsteR_0.X.X.pdf <- full package documentation.
    ├── .Rbuildignore
    ├── .gitignore
    ├── DESCRIPTION
    ├── LICENSE
    ├── LICENSE.md
    ├── NAMESPACE
    ├── README.md          <- Top-level README
    └── bolsteR.Rproj

Basic Workflow
------------------------

  1. Update your local repo (`git pull origin master`)
  2. Create a working branch (`git checkout -b new_feature`)
  3. Make changes on your branch
  4. Commit your changes locally (`git add`, `git commit -m "description of your commit"`)
  5. Upload the changes (your branch) to GitHub (`git push origin new_feature`)
  6. Go on to GitHub, create a "Pull Request"
  7. Assign a reviewer who can check your code
  7. After successful review, the changes are merged into the main branch

----

Example Usage

# Instantiate a copy of class Country_R6:
Kenya <- Country_R6$new(
                country_name = "Kenya",
                hs_API_key = get_hs_API_key())

# query health facilities from Kenya:
Kenya$initiate_HS_API()

# View the map in the viewer:
Kenya$get_facilities_map()

# Get data from a specific DHS surevy:
Kenya$
   initiate_DHS_API()$
   get_dhs_survey_data(survey = 1989)

The package is shipped with a demo shiny app the allows the user to interact swiftly with the APIs. Execute run_API_demo_App() in the console to run the app.

And then select the APIs you wish to download, for example the image below shows Kenya.

Please let us know if you have any comments or questions about the project structure or workflow.

Paul, Rob & Wael Dark Peak Analytics

dark-peak-analytics/who_decide_AP documentation built on May 25, 2022, 8:31 p.m.