You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-24Lines changed: 31 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ A list of core team members responsible for the code and documentation in this r
18
18
19
19
### Dependencies
20
20
21
-
This product relies on using R and Quarto to extract, munging, and export the visualizations. In addition to having these tools, a variety of R libraries were used in the process. This product leverages a through git/GitHub, but also through creating a reproducible envionment using the [`renv` package](https://rstudio.github.io/renv/index.html), "[making] it easier to share ... code in such a way that everyone gets exactly the same package versions". Loading this R project will allow "renv will automatically bootstrap itself, downloading and installing the appropriate version of renv" and "ask them if they want to download and install all the packages it needs by running `renv::restore()`." As more packages are added, run "`renv::snapshot()` to record the latest package versions in your lockfile."
21
+
This product relies on using R and [Quarto](https://quarto.org/docs/dashboards/) to extract, munging, and export the visualizations. In addition to having these tools, a variety of R libraries were used in the process. This product leverages a through git/GitHub, but also through creating a reproducible envionment using the [`renv` package](https://rstudio.github.io/renv/index.html), "[making] it easier to share ... code in such a way that everyone gets exactly the same package versions". Loading this R project will allow "renv will automatically bootstrap itself, downloading and installing the appropriate version of renv" and "ask them if they want to download and install all the packages it needs by running `renv::restore()`." As more packages are added, run "`renv::snapshot()` to record the latest package versions in your lockfile."
22
22
23
23
- R >= 4.0
24
24
- Quarto >= 1.3
@@ -28,19 +28,20 @@ This product relies on using R and Quarto to extract, munging, and export the vi
28
28
29
29
The script to render the final output can be found in the `Scripts/` folder.
30
30
31
-
-`01_setup_working_dataset.R` - Reads in each of the Excel tabs from all Fast Fast files in the `Data` folder to produce structured dataset to work from
32
-
-`02_data_dictionary.R` - Renders a data dictionary that updates with any inputs to the setup script.
33
-
-`03_data_processing.R` - Munges the data in a way that is needed for the creating visuals to minimal work needs to be done in the Quarto file.
34
-
-`04_render_views.R` - Script that can run prior script before rendering the Quarto views.
31
+
-`01_setup_working_dataset.R` - Reads in each of the Excel tabs from all Fast Fast files in the `Data` folder to produce structured dataset to work from.
32
+
-`02_include_addtl_data.R` - Imports additional CMS data useful for filling in gaps of data that are not available within the Fast Facts resource.
33
+
-`03_data_dictionary.R` - Renders a data dictionary that updates with any inputs to the setup script.
34
+
-`04_data_processing.R` - Munges the data in a way that is needed for the creating visuals to minimal work needs to be done in the Quarto file.
35
+
-`05_render_views.R` - Script that can run prior script before rendering the Quarto views.
35
36
36
-
Additional utilities can be found in the scripts with prefixes that start with 90.
37
+
Additional utilities can be found in the scripts with prefixes that start with 9*.
37
38
38
39
-`98_color_system.R` - unified color system, base colors, scales, and plot elements
39
40
-`99_functions.R` - utility functions used throughout processing
40
41
41
42
With the scripts run, you can render the Quarto dashbaord file sitting in the base folder of the directory. Run `quarto render fast-facts.qmd` to build. This produces a self-contained fast-facts.html file.
42
43
43
-
Unlike other Quarto outputs, the dashboard structure that this product utilizes is not able to render a PDF. The `04_render_views.R` is the initial attempt to create screenshots of it to turn into a PDF, but is still in its infancy and requires manual caputring through your internet browser, which is detailed below.
44
+
Unlike other Quarto outputs, the dashboard structure that this product utilizes is not able to render a PDF. The `05_render_views.R` is the initial attempt to create screenshots of it to turn into a PDF, but is still in its infancy and requires manual caputring through your internet browser, which is detailed below.
44
45
45
46
#### Capturing screenshots
46
47
@@ -59,44 +60,50 @@ Compiling to PDF in Acrobat
59
60
60
61
## Repository Structure
61
62
62
-
Below is the folder structure for this repository, run with `r fs::dir_tree(recurse = 0)`.
63
+
Below is the folder structure for this repository.
0 commit comments