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
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ This project requires a recent version of GNU `make` and docker.
26
26
27
27
The easiest way to view and develop this project locally is to run the Shiny app from RStudio:
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
+
<imgwidth="1111"alt="RStudio Screen Shot with Run App button circled"src="https://user-images.githubusercontent.com/14190352/131359925-3b460d21-b9aa-4a40-a691-cd705ab98431.png">
30
30
31
31
This is the same as running
32
32
@@ -38,13 +38,13 @@ in R. However, dashboard behavior can differ running locally versus running in a
38
38
39
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.
40
40
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.
41
+
The pipeline can be run locally with the `Report/create_reports.R` script or in a container. See notes in the Makefile for workarounds if you don't have image repository access.
42
42
43
43
## Running the scoring pipeline
44
44
45
45
The scoring pipline use a containerized R environment. See the `docker_build` directory for more details.
46
46
47
-
The pipeline can be run locally with the `Report/create_reports.R` script and in a container via
47
+
The pipeline can be run locally with the `Report/create_reports.R` script or in a container via
48
48
49
49
```bash
50
50
> make score_forecast
@@ -77,8 +77,8 @@ Update version number in the [DESCRIPTION file](https://github.com/cmu-delphi/fo
git tag -a v<major>.<minor>.<patch> -m "Version <major>.<minor>.<patch>"
80
-
git push origin release_v<major>.<minor>.patch><
81
-
git push origin v<major>.<minor>.patch><
80
+
git push origin release_v<major>.<minor>.<patch>
81
+
git push origin v<major>.<minor>.<patch>
82
82
```
83
83
Create a PR into `main`. After the branch is merged to `main`, perform cleanup by merging `main` into `dev` so that `dev` stays up to date.
84
84
@@ -88,7 +88,7 @@ The scoring pipeline runs in a docker container built from https://github.com/cm
88
88
89
89
When updates are made in the `evalcast` package the behavior of the scoring script can be affected and the `covidcast` docker image must be rebuilt. The [workflow in the `covidcast-docker` repository](https://github.com/cmu-delphi/covidcast-docker/blob/c5adf4bd088268398d574fc0658c8ac70953f91d/.github/workflows/main.yml) that does this needs to be triggered manually. Before building the new image, ensure that the changes in `evalcast` will be compatible with the scoring pipeline.
90
90
91
-
Currently, the scoring pipeline [uses the `evalcast`branch](https://github.com/cmu-delphi/covidcast-docker/blob/c5adf4bd088268398d574fc0658c8ac70953f91d/docker/dependencies.R#L18) of the [`evalcast`package](https://github.com/cmu-delphi/covidcast/tree/evalcast/R-packages/evalcast). However, if we need to make forecast eval-specific changes to the `evalcast` package that would conflict with other use cases, we have in the past created a dedicated branch of `evalcast`.
91
+
Currently, the scoring pipeline uses the the [`evalcast`package](https://github.com/cmu-delphi/covidcast/tree/evalcast/R-packages/evalcast) from [the`evalcast`branch](https://github.com/cmu-delphi/covidcast-docker/blob/c5adf4bd088268398d574fc0658c8ac70953f91d/docker/dependencies.R#L18) of the `covidcast` repository. However, if we need to make forecast eval-specific changes to the `evalcast` package that would conflict with other use cases, we have in the past created a dedicated forecast-eval branch of `evalcast`.
0 commit comments