README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# covid19RiskPlanner

<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
<!-- badges: end -->

The goal of covid19RiskPlanner is to is to provide a `{shiny}` webui over 
estimates of COVID-19 risk in the US and around the world.  

## Installation

You can install the current version of covid19RiskPlanner from Github with:

``` r
remotes::install_github("appliedbinf/c19r-app")
```

Or by pulling the pre-built Docker image

```bash
docker pull appliedbioinformaticslab/c19r:latest
```

## Example

Run the application with:

```bash

docker run -it \
    -p 80:80 \
    -e MYSQL_USERNAME="username" \
    -e MYSQL_PASSWORD="password" \
    -e MYSQL_HOST="host" \
    appliedbioinformaticslab/c19r:latest

```