Introduction | Requirements | How to use | How to contribute | Contact
The purpose of the Dashboard is to serve as a learning tool for both local and central Government and will provide a clear and consistent set of data indicators to help to understand progress towards the outcomes and enablers set out in the National Framework.
Insights and analysis gathered from this tool will support the Department’s wider strategic aim to make stronger, measurable decisions that achieve better outcomes for children, young people and families. Having a national set of indicators, used by all local authorities, with a mechanism to bring them together in one place is integral to supporting the system to collaborate. In this way, local authorities can reflect and learn from others on progress towards the outcomes and enablers in children’s social care.
As well as a learning tool for local government, the Dashboard will help central government to understand system-wide success and issues and how children, young people and families are being supported.
- Production - https://department-for-education.shinyapps.io/csc-outcomes-enablers/
- Development - https://department-for-education.shinyapps.io/dev-csc-outcomes-enablers/
-
Installation of R Studio 1.2.5033 or higher
-
Installation of R 4.4.0 or higher
-
Installation of RTools40 or higher
-
R at an intermediate level, DfE R training guide
-
Particularly R Shiny
- There are no other access requirements. All datasets are publicly available.
-
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. 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.
For technical methodology and rationale on y-axis implementation, see https://github.com/dfe-analytical-services/CSC_outcomes_and_enablers/blob/development/Y_AXIS_DOCUMENTATION.md.
If you spot any issues with the application, please check first that it has not been reported as an issue already.
If no issue is open for your bug, please flag it in the "Issues" tab of this repository, and label as a bug. Alternatively, you can open a new bug report here.
If there are new features you would like to suggest you can submit a feature request here.
Only members of the team can merge pull requests. Add yauemily, nataliepaterson and jzaun444 as requested reviewers, and the team will review before merging.
If you have any questions about the dashboard, please contact [email protected] .