diff --git a/README.md b/README.md index e6cd2a5..5390f17 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -# *webmice*: Experimental REST API +# `webmice`: Experimental REST API for Multivariate Imputation by Chained Equations + +API - The Noun Project + ## Summary -We provide a very easy example of a REST API for the R package *mice*. The HTTP server is run locally on http://localhost:8080/ and also runs a Swagger API endpoint on http://localhost:8080/doc. +We provide a very easy example of a REST API for the R package `mice`. The HTTP server is run locally on http://localhost:8080/ and also runs a Swagger API endpoint on http://localhost:8080/doc. ## Start the REST API ### Docker @@ -28,7 +31,11 @@ Start the app: ```sh Rscript webmice.R ``` + Navigate to your browser http://localhost:8080/doc +## Acknowledgements +This project was supported by Utrecht University's [Open Science Fund](https://www.uu.nl/en/research/open-science/about-us/open-science-fund). +