Skip to content

Commit 0e83138

Browse files
authored
Update README with clarified scope (#41)
1 parent c5e6a4d commit 0e83138

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@
44
[![R-CMD-check](https://github.com/CDCgov/cfa-gam-rt/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CDCgov/cfa-gam-rt/actions/workflows/R-CMD-check.yaml)
55

66
> [!CAUTION]
7-
> This project is a work-in-progress. Any outputs may be misleading or even incorrect. Despite this project's early stage, all development is in public as part of the Center for Forecasting and Outbreak Analytics' goals around open development. Questions and suggestions are welcome through GitHub issues or a PR.
7+
> This project is an early-stage work-in-progress. Any outputs may be misleading or even incorrect. Despite this project's early stage, all development is in public as part of the Center for Forecasting and Outbreak Analytics' goals around open development. Questions and suggestions are welcome through GitHub issues or a PR.
88
99
## Overview
1010

1111
This project is an in-development R package for $R_t$ estimation using generalized additive models (GAMs).
1212
Over the last few years, GAMs have been used with some success to estimate epidemic growth rates and nowcast cases (see [Ward, 2021](https://doi.org/10.1136/bmjopen-2021-056636) and [Mellor, 2023](https://doi.org/10.1038/s43856-023-00424-4) for an overview of methods).
13+
GAM-based models enable rapid, adaptable protoyping, testing dfferent model structures and data sources with minimal computational and development cost.
1314
The [R package `{mgcv}`](https://cran.r-project.org/web/packages/mgcv/index.html) provides a flexible, fast, and robust interface to fit penalized-spline based models.
1415
However, the substantial research effort into spline-based approaches has not been unified into a shared R package.
1516

16-
This R package aims to become an opinionated re-implementation of the literature methods, with reasonable defaults for real-time epidemic modeling.
17+
This R package aims to become an opinionated re-implementation of the literature methods, with a focus on enabling hiearchical modeling.
1718
Development effort is optimized around real-time use-cases, with potential for right-truncation, noisy reporting, and uncertain data-generating processes.
1819
It is meant to be a simple drop-in tool to be run alongside more computationally intensive implementations like [`{EpiNow2}`](https://github.com/epiforecasts/EpiNow2).
1920

20-
At the moment, the package has some simple functionality to fit a adaptive smooth trend to epidemic data and produce a short forecast.
21+
At the moment, the package has some simple functionality to fit a adaptive smooth trend to a single epidemic timeseries and produce a short forecast.
2122
It has not yet been benchmarked relative to other approaches.
2223

2324
## Installation

0 commit comments

Comments
 (0)