Introduction | Requirements | How to use | How to contribute | Contact
The dashboard provides users with the ability to explore industry data for Further Education learners with a sustained employment destination in the 2020/21 academic year.
The dashboard includes two main tabs:
- Industry by subject: Shows which industries learners from the selected subject area go on to work in.
- Subject by industry: Shows which subjects learners from the selected industry studied.
A live version of the dashboard is available here: ADD LINK
-
Installation of R Studio 1.2.5033 or higher
-
Installation of R 3.6.2 or higher
-
Installation of RTools40 or higher
-
Clone or download the repo.
-
Open the R project in R Studio.
-
Run
renv::restore()to install dependencies. -
Run
shiny::runApp()to run the app locally.
Package control is handled using renv. As in the steps above, you will need to run renv::restore() if this is your first time using the project.
UI tests have been created using shinytest2 that test the app loads, that content appears correctly when different inputs are selected, and that tab content displays as expected. More should be added over time as extra features are added.
GitHub Actions provide CI by running the automated tests and checks for code styling. The yaml files for these workflows can be found in the .github/workflows folder.
The tests can be run locally using the command shinytest2::test_app().
- The app is deployed to the department's shinyapps.io subscription using GitHub actions. The yaml file for this can be found in the .github/workflows folder.
In general all .r files will have a usable outline, so make use of that for navigation if in RStudio: Ctrl-Shift-O.
The function tidy_code() is created in the Rprofile script and therefore is always available in the RStudio console to tidy code according to tidyverse styling using the styler package. This function also helps to test the running of the code and for basic syntax errors such as missing commas and brackets.
If you spot any issues with the application, please flag it in the "Issues" tab of this repository, and label as a bug.
Only members of the team can merge pull requests. Add hkeogan as a requested reviewer, and the team will review before merging.
If you have any questions about the dashboard please contact the team on [email protected].