Skip to content

seroanalytics/serovizr

Repository files navigation

serovizr

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. R-CMD-check.yaml codecov Docker Image Version GitHub License

R API for the SeroViz app. Based on the porcelain framework.

Developing

Install dependencies with:

remotes::install_deps(".", dependencies = TRUE)

Start the API locally by running:

devtools::load_all()
serovizr:::main()

Testing

Run tests with:

devtools::test()

Deploying

To build a Docker image:

./docker/build

To push to Dockerhub:

./docker/push

To run a built image:

 docker run -p 8888:8888 seroanalytics/serovizr:<branch-name>

These steps are run on CI.

For a complete list of available tags, see Dockerhub: https://hub.docker.com/repository/docker/seroanalytics/serovizr/tags

The API is deployed along with the SeroViz app itself; see: https://github.com/seroanalytics/seroviz?tab=readme-ov-file#deployment

Releases

No releases published

Packages

No packages published