From 5c8322dcced748e5372f74dbc0f59b2498ef4d06 Mon Sep 17 00:00:00 2001 From: "Logan C. Brooks" Date: Tue, 4 Jun 2024 11:47:54 -0700 Subject: [PATCH] docs (epiprocess.Rmd): attempt short intro intro + ref dplyr "verbs" --- vignettes/epiprocess.Rmd | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/vignettes/epiprocess.Rmd b/vignettes/epiprocess.Rmd index 2d67e28a..f278f827 100644 --- a/vignettes/epiprocess.Rmd +++ b/vignettes/epiprocess.Rmd @@ -9,16 +9,21 @@ editor_options: chunk_output_type: console --- -The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package provides +The [`{epiprocess}`](https://cmu-delphi.github.io/epiprocess/) package works +with epidemiological time series and version data to provide situational +awareness, processing and transformations in preparation for modeling, and +version-faithful model backtesting. It contains: - `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); +- [`{dplyr}`](https://dplyr.tidyverse.org/)-esque "verbs" 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. +- [`{dplyr}`](https://dplyr.tidyverse.org/)-esque "verbs" for version-faithful + "pseudoprospective" backtesting of models, and other version history analysis + and transformations. It is part of a broader suite of packages including [`{epidatr}`](https://cmu-delphi.github.io/epidatr/),