Analysis of analytics data for our explore education statistics (EES) service, pulling in data from a number of sources to disseminate out. Primarily shared with publishers on the service to understand usage of their content, and with the EES service team for assessing service performance.
There are two main parts to this repository:
- Ad hoc analysis scripts (
adhoc-scripts/) - Data processing and update pipelines (
data-updates/)
Guides for each of these are provided in the README files in the respective folders. There is a high level diagram of the analytics data ingestion and processing.
There is an R Shiny dashboard that sits on top of this data in a separate GitHub repository - https://github.com/dfe-analytical-services/ees-analytics-dashboard.
If you want to make edits to the code or run anything locally, start by familiarising yourself with the specific README in the part of the project you're intending to use.
We have some pre-commit hooks set up to help with code quality. These are controlled by the .hooks/pre-commit.R file. Two functions you should run regularly if contributing are:
styler::style_dir()
lintr::lint_dir()This will style code according to tidyverse styling. lintr will check all pull requests and fail if code is not appropriately formatted.