Skip to content

Commit 34787e9

Browse files
committed
doc: update documentation on readme
1 parent 3e2f34d commit 34787e9

1 file changed

Lines changed: 31 additions & 24 deletions

File tree

README.md

Lines changed: 31 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A list of core team members responsible for the code and documentation in this r
1818

1919
### Dependencies
2020

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."
2222

2323
- R >= 4.0
2424
- Quarto >= 1.3
@@ -28,19 +28,20 @@ This product relies on using R and Quarto to extract, munging, and export the vi
2828

2929
The script to render the final output can be found in the `Scripts/` folder.
3030

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.
3536

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*.
3738

3839
- `98_color_system.R` - unified color system, base colors, scales, and plot elements
3940
- `99_functions.R` - utility functions used throughout processing
4041

4142
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.
4243

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.
4445

4546
#### Capturing screenshots
4647

@@ -59,44 +60,50 @@ Compiling to PDF in Acrobat
5960

6061
## Repository Structure
6162

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.
6364

65+
<!--
66+
run with `r fs::dir_tree(recurse = 2)
67+
-->
6468
```
6569
.
6670
├── CODEOWNERS.md
6771
├── CODE_OF_CONDUCT.md
6872
├── COMMUNITY.md
6973
├── CONTRIBUTING.md
7074
├── Data
71-
│ ├── CMSFastFacts2026.xlsx
72-
│ ├── Historic
75+
│ ├── README.md
76+
│ ├── cms_gov
77+
│ ├── data_cms_gov
78+
│ ├── fast_facts
79+
│ └── medicaid_scorecard
7380
├── Dataout
74-
│ ├── CMSFastFacts_SD_2026-04.csv
75-
│ ├── CMSFastFacts_SD_2026-04.parquet
76-
│ ├── beneficiaries.rds
77-
│ ├── context.rds
78-
│ ├── cost_sharing.rds
79-
│ └── providers.rds
81+
│ ├── CMSFastFactsPlus_SD_2026-06.parquet
82+
│ └── CMSFastFacts_SD_2026-06.parquet
8083
├── Documents
8184
│ └── CMSFastFacts_data-dictionary.pdf
8285
├── LICENSE
86+
├── README.html
8387
├── README.md
8488
├── SECURITY.md
8589
├── Scripts
8690
│ ├── 01_setup_working_dataset.R
87-
│ ├── 02_data_dictionary.R
88-
│ ├── 03_data_processing.R
89-
│ ├── 04_render_views.R
91+
│ ├── 02_include_addtl_data.R
92+
│ ├── 03_data_dictionary.R
93+
│ ├── 04_data_processing.R
94+
│ ├── 05_render_views.R
9095
│ ├── 98_color_system.R
9196
│ └── 99_functions.R
9297
├── assets
98+
│ ├── CMS_logo.jpeg
9399
│ ├── CMS_logo_reverse.png
94-
│ └── ff_format.scss
100+
│ ├── FontAwesome7Free-Solid-900.otf
101+
│ ├── ff_format.scss
102+
│ └── print.css
103+
├── code.json
104+
├── fast-facts.html
95105
├── fast-facts.qmd
96106
├── renv
97-
│ ├── activate.R
98-
│ ├── library
99-
│ └── settings.json
100107
├── renv.lock
101108
└── repolinter.json
102109
```
@@ -166,7 +173,7 @@ lintr::lint("Scripts/my_script.R")
166173
lintr::lint_dir()
167174
```
168175

169-
Note: Some files (e.g. `Scripts/02_data_dictionary.R`) include inline `# nolint` annotations where long lines are intentional and unavoidable.
176+
Note: Some files (e.g. `Scripts/03_data_dictionary.R`) include inline `# nolint` annotations where long lines are intentional and unavoidable.
170177

171178
<!--
172179
## Branching Model

0 commit comments

Comments
 (0)