Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RobertASmithBresMed/plumberHE
Health Economics using Plumber APIs
https://github.com/RobertASmithBresMed/plumberHE
Last synced: 8 days ago
JSON representation
Health Economics using Plumber APIs
- Host: GitHub
- URL: https://github.com/RobertASmithBresMed/plumberHE
- Owner: RobertASmithBresMed
- License: mit
- Created: 2022-04-13T10:40:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-24T21:19:03.000Z (about 2 years ago)
- Last Synced: 2024-08-13T07:11:09.115Z (4 months ago)
- Language: R
- Size: 12 MB
- Stars: 6
- Watchers: 0
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - RobertASmithBresMed/plumberHE - Health Economics using Plumber APIs (R)
README
[](https://zenodo.org/badge/latestdoi/481174680)
[](https://opensource.org/licenses/mit-license.php)
This repository was originally created for the [R-HTA](https://r-hta.org/) workshop, held in Oxford on Thursday 19th May 2022. The slides for this presentation can be found [here](https://github.com/RobertASmithBresMed/plumberHE/blob/main/publication/Living%20HTA%20May22.pdf). The presentation is on [Youtube](https://www.youtube.com/watch?v=hqQV9jdCRyg)
Live app for this branch: [https://robertasmith.shinyapps.io/app_golem/](https://robertasmith.shinyapps.io/app_golem/). The API Key is the full https://doi.org URL of the paper.
An [academic paper](https://wellcomeopenresearch.org/articles/7-194) has passed peer review at Wellcome Open Research. Please cite as:
>Smith RA, Schneider PP and Mohammed W. Living HTA: Automating Health Technology Assessment with R. Wellcome Open Res 2022, 7:194 (https://doi.org/10.12688/wellcomeopenres.17933.2)
# **Living HTA: Automating Health Economic Evaluation with R**
Robert Smith1,2,3, Paul Schneider1,3 & Wael Mohammed1,3
1 [University of Sheffield](https://www.sheffield.ac.uk/scharr), University of Sheffield, Sheffield, UK
2 [Lumanity](https://lumanity.com/), Sheffield, UK
3 [Dark Peak Analytics](https://darkpeakanalytics.com/), Sheffield, UK;
>#### **Background**
>
>Requiring access to sensitive data can be a significant obstacle for the development of health models in the Health Economics & Outcomes Research (HEOR) setting. We demonstrate how health economic evaluation can be conducted with minimal transfer of data between parties, while automating reporting as new information becomes available.
>
>#### **Methods**
>
>We developed an automated analysis and reporting pipeline for health economic modelling and made the source code openly available on a GitHub repository. The pipeline consists of three parts: An economic model is constructed by the consultant using pseudo data. On the data-owner side, an application programming interface (API) is hosted on a server. This API hosts all sensitive data, so that data does not have to be provided to the consultant. An automated workflow is created, which calls the API, retrieves results, and generates a report.
>
>#### **Results & Discussion**
>
>The application of modern data science tools and practices allows analyses of data without the need for direct access – negating the need to send sensitive data. In addition, the entire workflow can be largely automated: the analysis can be scheduled to run at defined time points (e.g. monthly), or when triggered by an event (e.g. an update to the underlying data or model code); results can be generated automatically and then be exported into a report. Documents no longer need to be revised manually.
>
>#### **Conclusions**
>
>This example demonstrates that it is possible, within a HEOR setting, to separate the health economic model from the data, and automate the main steps of the analysis pipeline.
## Diagram
## Creating the API
The example plumber code used to generate the API can be found in the `darthAPI` folder. This is a development version of the code.
## Using the API
The file `scripts/run_darthAPI.R` is the file run by the automated workflow.
Within this file is a call to the API, shown below, undertaken using the `httr` package.
It is not possible to run this function yourself, since it requires the API key, which I have stored as an environment variable `CONNECT_KEY`. However the code used to call the API can be seen below:
```
# function to call API to run the model
httr::content(
httr::POST(
# the Server URL can also be kept confidential, but will leave here for now
url = "https://connect.bresmed.com",
# path for the API within the server URL
path = "rhta2022/runDARTHmodel",
# code is passed to the client API from GitHub.
query = list(model_functions =
paste0("https://raw.githubusercontent.com/",
"BresMed/plumberHE/main/R/darth_funcs.R")),
# set of parameters to be changed ...
# we are allowed to change these but not some others
body = list(
param_updates = jsonlite::toJSON(
data.frame(parameter = c("p_HS1","p_S1H"),
distribution = c("beta","beta"),
v1 = c(25, 50),
v2 = c(150, 100))
)
),
# we include a key here to access the API ... like a password protection
config = httr::add_headers(Authorization = paste0("Key ",
Sys.getenv("CONNECT_KEY")))
)
)
```
## Example App
An example app can be found in the `app_golem` folder. This contains a very simple R shiny application which allows users to query the API for different variable inputs. An online versio of this app can be found [here](https://rasmithbresmed.shinyapps.io/app_golem/) To run the demo app locally run:
```
# set the working directory to the golem app
setwd("app_golem")
# load the packages necessary
pkgload::load_all(export_all = FALSE,
helpers = FALSE,
attach_testthat = FALSE)
# include options here.
options( "golem.app.prod" = TRUE)
# run the 'run_app' function
livinghta::run_app() # add parameters here (if any)
```
## Creating the automated workflow
The automated workflow is run on GitHub actions at 00:01 at the first of each month, and can be found in `.github/workflows/auto_model_run.yml`.