Before using this template, please contact the Statistics Development Team (statistics.development@education.gov.uk) to discuss your plans for setting up a DfE dashboard.
This template repository is for making accessible apps for published statistics in DfE. It includes a basic accessible shiny app with DfE styling, as well as templates for additional best practice documents like this README script, pull request templates and codes of conduct for contributing.
To use this template, click the green "use this template" button at the top of the repo. This will create a copy for you to work off of.
Please delete this header section when you are writing up the README file for your own app.
Please contact statistics.DEVELOPMENT@education.gov.uk if you have any questions, or raise an issue on here if you have spotted something specific that we should change.
Introduction | Requirements | How to use | How to contribute | Contact
Give a brief overview of what your app is for here.
Add links to where each version of your app is deployed - e.g.
- Production - https://rsconnect/rsc/dfe-published-data-qa
- Pre-production - https://rsconnect-pp/rsc/dfe-published-data-qa
- Development - https://rsconnect-pp/rsc/dev-dfe-published-data-qa
You should list out the software and programming skills needed, as well as any access requirements = e.g.
-
Installation of R Studio 1.2.5033 or higher
-
Installation of R 3.6.2 or higher
-
Installation of RTools40 or higher
-
R at an intermediate level, DfE R training guide
-
Particularly R Shiny
- Access to the Stats Development Team SQL modelling area (MA_SDT_NS_DATA) in T1PRANMSQL\SQLPROD,60125. Request access from Cam Race and forward on your request to the PDR mailbox (PupilData.REPOSITORY@education.gov.uk)
You should clearly lay out the steps needed to run your code here - generally, they will be similar to the below for Shiny apps:
-
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 shinytest 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 function run_tests_locally() is created in the Rprofile script and is available in the RStudio console at all times to run both the unit and ui tests.
- 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.
Details on how to contribute to the app should go here, e.g.
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 Statistics Development team can merge pull requests. Add lauraselby, cjrace and sarahmwong as requested reviewers, and the team will review before merging.
Add contact details of how to get in touch with your team.