DETECT RPC APS BL Dashboard

Welcome to the DETECT RPC APS BL Dashboard project! This documentation guides new users through installation, setup, and development.

---

Table of Contents

1. Introduction
2. Prerequisites
3. Installation
4. Project Setup
5. Building the Dashboard
6. Development Workflow
7. Contributing

---

Introduction

The DETECT RPC APS BL Dashboard project provides a Quarto dashboard to efficiently monitor new and existing submissions for the APS Baseline data.

---

Prerequisites

System Requirements:

• Operating System: Windows, macOS, or Linux
• Memory: Minimum 8 GB RAM
• Storage: At least 10 GB free space

Software Requirements:

• R (version 4.5)
• Positron OR RStudio IDE (latest version)
• Quarto (version 1.7.*)
• Git (latest version)

---

Installation

Follow these steps to install necessary software:

Step 1: Install R

• Download and install R from CRAN

Step 2: Install an IDE (RStudio or Positron)

• Download and install the latest version of RStudio or Positron from Posit

Step 3: Install Quarto

• Download and install Quarto from Quarto

Step 4: Install Git

• Download and install the latest version from Git

Verify installations by opening your terminal and checking versions:

R --version
quarto --version
git --version

---

Project Setup

Step 1: Clone the Repository

git clone https://github.com/brad-cannell/DETECT-RPC-APS-BL-Dashboard.git
cd DETECT-RPC-APS-BL-Dashboard

Note

Don't clone to a cloud storage folder (Box, Dropbox, Google Drive, OneDrive, etc.). File-locking and sync conflicts can corrupt the renv library.

Step 2: Open in the IDE

• Open DETECT-RPC-APS-BL-Dashboard in the IDE.

Step 3: Install Project Dependencies

In the R console:

install.packages('renv')
renv::restore()

This project uses renv to manage project package dependencies. Click the link for more details.

Note

renv::restore() may take several minutes and requires an active internet connection.

Step 4: Request an API Key

Instructions for requesting API keys

API Keys needed:

• DETECT-RPC Baseline Reporting Data
  • REDCap: https://redcap.uth.tmc.edu/index.php
  • Project: DETECT-RPC APS Reporting

Step 5: Add Your API Key to Keyring

keyring::key_set("aps_reports_redcap_api")

Click for additional information about the keyring package

---

Building the Dashboard

This section assumes you have already successfully completed all of the installation and project setup steps above.

Step 1: Render the Dashboard

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

rscript data_operations.R
quarto render aps-dashboard.qmd

Step 2: View in Browser

• Open the generated HTML file in your browser. It is the file named index.html at the project root.

Step 3. Commit and Push to GitHub

git add .
git commit -m "YYYY-MM-DD Dashboard Update"
git push

---

Development Workflow

Branching

Use feature branches for development:

git checkout -b feature/your-feature-name

Commit Changes

Make commits descriptive and focused:

git add .
git commit -m "Describe changes clearly"

Push to Remote

Push your feature branch:

git push origin feature/your-feature-name

---

Contributing

1. Fork the repository.
2. Create your feature branch.
3. Submit a Pull Request (PR) to the main repository.
4. Clearly document your changes in the PR description.