Issue 248: Add package workflow diagram to readme (#249)

* add language to readme * Add files via upload * Add files via upload * remove fig * Add files via upload * add svg * delete png * add package workflow diagram * run pre-commit locally * Add files via upload * Update README.md * Update README.md Co-authored-by: George G. Vega Yon <[email protected]> --------- Co-authored-by: George G. Vega Yon <[email protected]>
CDCgov · Nov 6, 2024 · 878d7f8 · 878d7f8
1 parent c24acfd
commit 878d7f8
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,7 @@
 - Add wastewater data into the forecast period to output in `generate_simulated_data()` function and as package data. Also adds subpopulation-level
 hospital admissions to output of function and package data. ([#184](https://github.com/CDCgov/ww-inference-model/issues/184))
 - `wwinference` now checks whether `site_pop` is fixed per site (see issue [#223](https://github.com/CDCgov/ww-inference-model/issues/226) reported by [@akeyel](https://github.com/akeyel)).
+- Add package workflow diagram to readme ([#248](https://github.com/CDCgov/ww-inference-model/issues/248))
 - `get_plot_subpop_rt()` now uses a shared y-axis to facilitate comparison of R(t) estimates) ([#245](https://github.com/CDCgov/ww-inference-model/issues/245))
 
 ## Internal changes

diff --git a/README.md b/README.md
@@ -27,6 +27,10 @@ This will help make clear the data requirements and how to structure this data t
 - Sam Abbott (seabbs)
 - Damon Bayer (damonbayer)
 
+# Package workflow
+The following depicts the suggested workflow for fitting the wastewater-informed forecasting model. See the ["Getting Started" vignette](https://cdcgov.github.io/ww-inference-model/articles/wwinference.html) for a full example.
+![](./man/figures/wwinference_workflow.png)
+
 # Installing and running code
 
 ## Install R

diff --git a/man/figures/wwinference_package_workflow.svg b/man/figures/wwinference_package_workflow.svg
diff --git a/man/figures/wwinference_workflow.png b/man/figures/wwinference_workflow.png