-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
59 lines (39 loc) · 1.47 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
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%"
)
```
# Nowcasting examples
This repository contains two example approaches to nowcasting, one using the [EpiNow2](https://epiforecasts.io/EpiNow2/) package, and one using the [epinowcast](https://epiforecasts.io/epinowcast/) package which is currently being developed to eventually replace `EpiNow2` for real-time applications.
## Installation
You can install the utility functions contained in this repo with
```{r install, eval = FALSE}
# install.packages("devtools")
devtools::install_github("epiforecasts/nowcasting.example")
```
## Render the `EpiNow2` report
To render the report, run
``` r
rmarkdown::render("inst/reports/epinow2.Rmd")
```
Afterwards the report can be viewed in
`inst/reports/epinow2.html`. A [rendered version](inst/reports/epinow2.md) of the report is also available in the repository.
## Render the `epinowcast` report
To render the report, run
``` r
rmarkdown::render("inst/reports/epinowcast.Rmd")
```
Afterwards the report can be viewed in
`inst/reports/epinowcast.html`. A [rendered version](inst/reports/epinowcast.md) of the report is also available in the repository.
## Create mock dataset
A mock dataset can be created using
```{r data, eval = FALSE}
source("inst/scripts/create_mock_dataset.r")
```