update README with yld for burden_disease

imperialCHEPI · Nov 14, 2024 · c1d8816 · c1d8816
1 parent 413d80b
commit c1d8816
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -91,6 +91,13 @@ inc_cum("diabetes",
   )
 ```
 
+To plot burden of disease for, say, "yld", you can use the following code:
+
+```{r burden_disease_plot}
+data_weighted_bd_wide_collapse <- gen_data_weighted_burden(data_weighted)
+burden_disease("yld", data_weighted_bd_wide_collapse)
+```
+
 <!--
 ### Cloning the Repository
 

diff --git a/README.md b/README.md
@@ -113,6 +113,20 @@ inc_cum("diabetes",
 
 <img src="man/figures/README-inc_cum_plot-1.png" width="100%" />
 
+To plot burden of disease for, say, “yld”, you can use the following
+code:
+
+``` r
+data_weighted_bd_wide_collapse <- gen_data_weighted_burden(data_weighted)
+burden_disease("yld", data_weighted_bd_wide_collapse)
+#> Warning: Use of `data_weighted_bd_wide_collapse$time` is discouraged.
+#> ℹ Use `time` instead.
+#> Use of `data_weighted_bd_wide_collapse$time` is discouraged.
+#> ℹ Use `time` instead.
+```
+
+<img src="man/figures/README-burden_disease_plot-1.png" width="100%" />
+
 <!--
 ### Cloning the Repository
 &#10;```bash

diff --git a/man/figures/README-burden_disease_plot-1.png b/man/figures/README-burden_disease_plot-1.png