Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address Guidehouse feedback on landing page #450

Merged
merged 3 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: epiprocess
Title: Tools for basic signal processing in epidemiology
Version: 0.7.9
Version: 0.7.10
Authors@R: c(
person("Jacob", "Bien", role = "ctb"),
person("Logan", "Brooks", email = "[email protected]", role = c("aut", "cre")),
Expand Down
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Pre-1.0.0 numbering scheme: 0.x will indicate releases, while 0.x.y will indicat
(#441).
- Clarified "Get started" example of getting Ebola line list data into `epi_df`
format.
- Improved documentation web site landing page's introduction.

# epiprocess 0.7.0

Expand Down
50 changes: 46 additions & 4 deletions vignettes/epiprocess.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,56 @@ editor_options:
chunk_output_type: console
---

This package introduces a common data structure for epidemiological data sets
measured over space and time, and offers associated utilities to perform basic
signal processing tasks.
The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package provides
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: give broad intro before detailed list

Suggested change
The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package provides
The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package introduces a common data structure for epidemiological data sets
measured over space and time, and offers associated utilities to perform basic
signal processing tasks.
The package provides the following tools:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That intro intro's not accurate, I've taken a shot at an accurate one.


- `epi_df`, a class for working with epidemiological time series data;
- `epi_archive`, a class for working with the version history of such time series data;
- sample data in these formats;
- functions for common data transformations (e.g., 7-day averages);
- functions for exploratory data analysis and situational awareness (e.g.,
outlier detection and growth rate estimation); and
- functions for version-faithful "pseudoprospective" backtesting of models, and
other version history analysis.

It is part of a broader suite of packages including
[`{epidatr}`](https://cmu-delphi.github.io/epidatr/),
[`{epidatasets}`](https://cmu-delphi.github.io/epidatasets/),
[`{rtestim}`](https://dajmcdon.github.io/rtestim/), and
[`{epipredict}`](https://cmu-delphi.github.io/epipredict/), for accessing,
brookslogan marked this conversation as resolved.
Show resolved Hide resolved
analyzing, and forecasting epidemiological time series data. We have expanded
documentation and demonstrations for some of these packages available in an
online "book" format [here](https://cmu-delphi.github.io/delphi-tooling-book/).

## Motivation

[`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) and
[`{epipredict}`](https://cmu-delphi.github.io/epipredict/) are designed to lower
the barrier to entry and implementation cost for epidemiological time series
analysis and forecasting. Epidemiologists and forecasting groups repeatedly and
separately have had to rush to implement this type of functionality in a much
more ad hoc manner; we are trying to save such effort in the future by providing
well-documented, tested, and general packages that can be called for many common
tasks instead.

[`{epiprocess}`](https://github.com/cmu-delphi/epiprocess/) also provides tools
to help avoid a particularly common pitfall in analysis and forecasting:
ignoring reporting latency and revisions to a data set. This can, for example,
lead to one retrospectively analyzing a surveillance signal or forecasting model
and concluding that it is much more accurate than it actually was in real time,
or producing always-decreasing forecasts on data sets where initial surveillance
estimates are systematically revised upward. Storing and working with version
history can help avoid these issues.

## Intended audience

We expect users to be proficient in R, and familiar with the
[`{dplyr}`](https://dplyr.tidyverse.org/) and
[`{tidyr}`](https://tidyr.tidyverse.org/) packages.

## Installing

This package is not on CRAN yet, so it can be installed using the
[`devtools`](https://devtools.r-lib.org) package:
[`{devtools}`](https://devtools.r-lib.org) package:

```{r, eval = FALSE}
devtools::install_github("cmu-delphi/epiprocess", ref = "main")
Expand Down
Loading