README.md

hefpi

Lifecycle:
experimental

hefpi is a web application for the visual exploration of the World Bank’s Health Equity and Financial Protection Indicators. It is currently under active development.

Installation

You can install hefpi from github by running the following:

devtools::install_github('databrew/hefpi')

Development

To work on developing this package, you’ll likely want to focus on the following files:

Deploy

To deploy on a shiny server, simply place an app.R file in a folder as one normally would do, and populate that file with the following lines:

library(hefpi)
run_app()

Reproducing this package

In order to build this package and run the application correctly, one should:

  1. Clone this repository from the command line: git clone https://github.com/databrew/hefpi.
  2. Install the hefpi package in R: devtools::install_github('databrew/hefpi')
  3. Run Rscript dev/run_dev.R from the command line or in Rstudio.

The package

The HEFPI dashboard is structured as a R package (created with golem https://cran.r-project.org/web/packages/golem/vignettes/a_start.html)

The primary files: - dev/run_dev.R: The code you'll use to run the app locally after making changes - inst/app/www/*: logos, fonts, and the custom.css file that controls the CSS for the app. - misc/guide.md: AWS admin guide for setting up shiny app. - data-raw/from_other/* - data-raw/from_wb/* - data-raw/from_website/* - data-raw/raw_data.R - data/* - R/app_config.R: Used to read insdie golem config file inst/golem-config.yml - R/app_ui.R: all ui modules (top level) - note: the "By urban-rural" tab is a placeholder with no charts (to be added later).



databrew/hefpi documentation built on March 30, 2023, 3:58 p.m.