Skip to content

Commit dcb544e

Browse files
committed
Update README
1 parent cedaafb commit dcb544e

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The DETECT RPC APS BL Dashboard project provides a Quarto dashboard to efficient
3333
### Software Requirements:
3434

3535
* [R](https://cran.r-project.org/) (version 4.5)
36-
* [RStudio](https://posit.co/download/rstudio-desktop/) (latest version)
36+
* [Positron](https://positron.posit.co/) **OR** [RStudio](https://posit.co/download/rstudio-desktop/) IDE (latest version)
3737
* [Quarto](https://quarto.org/docs/get-started/) (version 1.7.\*)
3838
* [Git](https://git-scm.com/downloads) (latest version)
3939

@@ -79,7 +79,7 @@ cd DETECT-RPC-APS-BL-Dashboard
7979
```
8080

8181
> [!NOTE]
82-
> Don't clone to a cloud storage folder (Box, Dropbox, Google Drive, OneDrive, etc.)
82+
> Don't clone to a cloud storage folder (Box, Dropbox, Google Drive, OneDrive, etc.). File-locking and sync conflicts can corrupt the renv library.
8383
8484
### Step 2: Open in the IDE
8585

@@ -96,6 +96,9 @@ renv::restore()
9696

9797
This project uses [renv](https://rstudio.github.io/renv/articles/renv.html) to manage project package dependencies. Click the link for more details.
9898

99+
> [!NOTE]
100+
> `renv::restore()` may take several minutes and requires an active internet connection.
101+
99102
### Step 4: Request an API Key
100103

101104
[Instructions for requesting API keys](https://github.com/brad-cannell/r33_dashboards/wiki/DETECT%E2%80%90RPC-Data#accessing-data-through-api)
@@ -105,22 +108,26 @@ API Keys needed:
105108
- REDCap: https://redcap.uth.tmc.edu/index.php
106109
- Project: DETECT-RPC APS Reporting
107110

108-
### Step 4: Add Your API Key to Keyring
111+
### Step 5: Add Your API Key to Keyring
109112

110113
```r
111114
keyring::key_set("aps_reports_redcap_api")
112115
```
113116

117+
[Click for additional information about the keyring package](https://keyring.r-lib.org/)
118+
114119
---
115120

116121
## Building the Dashboard
117122

123+
This section assumes you have already successfully completed all of the installation and project setup steps above.
124+
118125
### Step 1: Render the Dashboard
119126

120127
In the IDE, navigate to the project root and run:
121128

122129
```shell
123-
rscript data_operations.r
130+
rscript data_operations.R
124131
quarto render aps-dashboard.qmd
125132
```
126133

@@ -133,6 +140,7 @@ quarto render aps-dashboard.qmd
133140
```shell
134141
git add .
135142
git commit -m "YYYY-MM-DD Dashboard Update"
143+
git push
136144
```
137145

138146
---

0 commit comments

Comments
 (0)