Setup - UCSB-MEDS/shiny-dashboard GitHub Wiki

Complete the following and familiarize yourself with the shared Google Drive and GitHub repositories before jumping into any updates.

1. Get access to the Bren Dashboard Shared Google Drive (Sam Shanny-Csik ([email protected]) or Jamie Montgomery ([email protected]) can provide access). This shared Google Drive primarily serves as a place to preserve dashboard data (raw & processed) and the google-analytics.html file, which is used to embed Google Analytics tracking code to monitor and analyze how users interact with the app. Data contain sensitive personal information and should never be pushed to GitHub. Similarly, we have chosen not to push google-analytics.html to GitHub. Preserving these files here on Google Drive allow all collaborators to access / download the files necessary for testing the app locally and deploying it. Inside the shared drive, you'll find the following file structure and contents:

.
├── google analytics/
|    └── google-analytics.html                                # embeds Google Analytics tracking code
|    
├── data/
|    └── career/                                              # includes raw and processed career outcomes data
|           └── raw-data/                                     # raw data from career team (downloaded from Salesforce after career exit surveys are complete)
|                   └── original-xlsx-files/                  # original raw data from career team
|                   └── MESM/                                 # raw MESM career outcomes data, converted to Google Sheets, and organized into year directories (1 initial placement & 1 active placement file per year)
|                   └── MEDS/                                 # raw MEDS career outcomes data, converted to Google Sheets, and organized into year directories (1 initial placement & 1 active placement file per year)
|           └── processed-data/                               # pre-processsed data (saved as .rds files); to be added to `shiny-dashboard` repo for additional cleaning before being used by dashboard
|                    └── 20**/                                # seperate directories for each year 
|                          └── mesm_placement_20XX_20XX.rds   # mesm initial job placements across years
|                          └── meds_placement_20XX_20XX.rds   # meds initial job placements across years
|                          └── mesm_status_20XX_20XX.rds      # mesm active job placements (status) across years
|                          └── meds_status_20XX_20XX.rds      # meds active job placements (status) across years
|
|    └── admissions/                                          # includes raw and processed application / admissions data
|           └── raw-data/                                     # raw data from admissions team
|                   └── application-exports/ 
|                               └── application-export-20XX   # all applicants / admitted / enrolled students, by year
|                   └── dropped-applications/ 
|                               └── MESM/MEDS Dropped Application IDs 20XX.csv # list of those who SIRed Yes, but did not end up attending, by year
|           └── processed-data/                               # pre-processsed data (saved as .rds files); to be added to `shiny-dashboard/` repo
|                   └── 20**/                                 # seperate directories for each year
|                          └── apps_20**_20**.rds    

2. Get added as a collaborator to the UCSB-MEDS GitHub Organization and clone the following repos (Sam Shanny-Csik or Jamie Montgomery can add collaborators):

• shiny-dashboard (public; houses the dashboard)
• career-data (private; for pre-processing career outcomes data)
• admissions-data (private; for pre-processing admissions / demographics data)

3. Create branches before beginning any work in the above repositories. In the terminal, run the following lines, one-by-one, to create a new branch. One complete, you can edit files and add / commit / push as normal.

# create a new local branch (e.g. csik-spring25-career-updates)
git checkout -b name-of-branch

# push local branch to GitHub
git push -u origin name-of-branch