You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-15Lines changed: 21 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -20,42 +20,48 @@ See the ["About" writeup](https://github.com/cmu-delphi/forecast-eval/blob/f12ab
20
20
21
21
# Contributing
22
22
23
-
1. Create a new branch off of `dev`
24
-
2. Create a pull request into `dev`
23
+
`main` is the production branch and shouldn't be directly modified. Pull requests should be based on and merged into `dev`. When enough changes have accumulated on `dev`, a release will be made to sync `main` with it.
25
24
26
-
**Note:** the easiest way to view and develop this project locally is to use RStudio and run the RShiny app from inside the IDE
25
+
This project requires a recent version of GNU `make` and docker.
26
+
27
+
The easiest way to view and develop this project locally is to run the Shiny app from RStudio:
27
28
28
29
<imgwidth="1111"alt="Screen Shot 2021-08-30 at 10 56 59 AM"src="https://user-images.githubusercontent.com/14190352/131359925-3b460d21-b9aa-4a40-a691-cd705ab98431.png">
29
30
30
-
Alternatively, ...
31
+
This is the same as running
31
32
33
+
```R
34
+
shiny::runApp("<directory>")
35
+
```
32
36
33
-
## Building
37
+
in R. However, dashboard behavior can differ running locally versus running in a container (due to package versioning, packages that haven't been properly added to the container environment, etc), so the dashboard should be also tested in a container.
34
38
35
-
This project requires a recent version of GNU make and docker.
39
+
The dashboard can be run in a Docker container using `make`. See notes in the Makefile for workarounds if you don't have image repository access.
36
40
37
-
Builds use a containerized R environment. See the `docker_build` directory for more details.
41
+
The pipeline can be run locally with the `Report/create_reports.R` script and in a container. See notes in the Makefile for workarounds if you don't have image repository access.
38
42
39
-
To build:
43
+
## Running the scoring pipeline
40
44
41
-
```bash
42
-
> make build
43
-
```
45
+
The scoring pipline use a containerized R environment. See the `docker_build` directory for more details.
44
46
45
-
To start `bash` shell in the docker container, which would let you start an R session:
47
+
The pipeline can be run locally with the `Report/create_reports.R` script and in a container via
46
48
47
49
```bash
48
-
> make start_repl
50
+
> make score_forecast
49
51
```
50
52
51
-
## Starting a local shiny server
53
+
See notes in the Makefile for workarounds if you don't have image repository access.
54
+
55
+
## Running the Shiny app
52
56
53
-
To start a docker image of the shiny server locally:
57
+
The dashboard can be run in a Docker container using
54
58
55
59
```bash
56
60
> make start_dashboard
57
61
```
58
62
63
+
See notes in the Makefile for workarounds if you don't have image repository access.
64
+
59
65
# Releasing
60
66
61
67
`main` is the production branch and contains the code that the public dashboard uses. Code changes will accumulate on the `dev` branch and when we want to make a release, `dev` will be merged into `main` via the ["Create Release" workflow](https://github.com/cmu-delphi/forecast-eval/blob/f12ab6f303ba81d6cbc32d61720061474496a00f/.github/workflows/create_release.yml). Version bump type (major, minor, etc) is specified manually when running the action.
0 commit comments