Skip to content

Commit d4e9240

Browse files
committed
Make README more informative
1 parent 89efbaa commit d4e9240

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,29 @@
44
[![R-CMD-check](https://github.com/lshandross/covidTHieF/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/lshandross/covidTHieF/actions/workflows/R-CMD-check.yaml)
55
<!-- badges: end -->
66

7-
Functions for forecasting COVID-19 hospitalizations with temporal hierarchical forecasting (THieF)
8-
from Athanasopoulos, et. al (2017), built using functions from the THieF package.
7+
This repository contains the data and code for the following paper:
8+
> Li Shandross, Evan L. Ray, Benjamin W. Rogers, Nicholas G. Reich. Forecasting COVID-19 Hospitalizations with Temporal Hierarchies. *medRxiv: The pre-print server for health sciences* (2025). doi: https://doi.org/10.1101/2025.06.26.25330355
9+
10+
## Contents
11+
12+
The R Weave source document `covid_thief.Rmd` (as well as a fully rendered version suitable for reading), can be found in the [:file_folder: paper](/analysis/paper) directory. Figures can also be found here.
13+
14+
The data used in this analysis can be found within the [:file_folder: data](/data) directory. Predictions are stored both as R data objects and individual CSV files for the THieF and ARIMA models in named directories.
15+
16+
Functions used to generate the forecasts can be found in the [:file_folder: R](/R) directory. The code for most of these functions is adapted those from the [THieF package](https://github.com/robjhyndman/thief).
17+
18+
## Setup
19+
20+
The code for this paper has been written using the statistical programming language R. We use a combination of renv (for package versioning) and targets (for a system agnostic make-like pipeline) to build the manuscript and supplement.
21+
22+
Begin by setting up the development environment by running the following command in an R session in the project:
23+
```
24+
renv::restore()
25+
```
26+
27+
Next, run the targets pipeline with the following command (note this does not render the manuscript):
28+
```
29+
targets::tar_make()
30+
```
31+
32+
To build the manuscript, open the source file `analysis/paper/covid_thief.rnw` in RStudio and click the render button. (The supplement can be built in the same way, or using `rmarkdown::render("analysis/paper/covid_thief_supplement.rmd")`.)

0 commit comments

Comments
 (0)