add renv lock and basic files

.github/workflows/dashboard-tests.yml

@@ -40,5 +40,5 @@ jobs:
       - name: Run tests 
         shell: Rscript {0}
         run: |
-          shinytest2::test_app("analytics-dashboard")
+          shinytest2::test_app()
           

.gitignore

@@ -1,2 +1,3 @@
 # {shinytest2}: Ignore new debug snapshots for `$expect_values()`
 *_.new.png
+.Rproj.user

.hooks/pre-commit.R

@@ -22,8 +22,8 @@ if (system.file(package = "git2r") == "") {
 }
 if (system.file(package = "rsconnect") != "" & system.file(package = "git2r") != "") {
   if (!any(grepl("manifest.json", git2r::status()))) {
-    rsconnect::writeManifest(paste0(getwd(), "/analytics-dashboard"))
-    git2r::add(path = "analytics-dashboard/manifest.json")
+    rsconnect::writeManifest()
+    git2r::add(path = "manifest.json")
   }
   message("...manifest.json rebuilt\n")
 } else {

README.md

@@ -1,14 +1,16 @@
 # Explore education statistics analytics - dashboard
 
-This is an R Shiny dashboard that is deployed via the DfE POSIT Connect subscription internally. There are three environments, all accessible to DfE AD:
+This is an R Shiny dashboard that visualises analytics data collected on our explore education statistics platform.
+
+It is deployed via the DfE POSIT Connect subscription internally. There are three environments, all accessible to DfE AD:
 
 * Production - https://rsconnect/rsc/ees-analytics/
 * Pre-production - https://rsconnect-pp/rsc/ees-analytics/
 * Development - https://rsconnect-pp/rsc/dev-ees-analytics/
 
-### Data updates
+## Data processing and update pipelines
 
-Source data for this dashboard is created and managed separately in the `data-updates/` folder.
+Code used to extract source data, process it, and save a permanent store for usage by the analytics dashboard, as well as ad hoc analysis scripts are in a separate GitHub repository - https://github.com/dfe-analytical-services/explore-education-statistics-analytics.
 
 ## Requirements
 
@@ -36,12 +38,38 @@ Package control is handled using [renv](https://rstudio.github.io/renv/articles/
 1. Clone or download the repo
 2. Open the R project in R Studio
 3. Run `renv::restore()` to install dependencies
-4. Run `shiny::runApp("analytics-dashboard")` to run the dashboard locally
+4. Run `shiny::runApp()` to run the dashboard locally
 
 ### Tests
 
-Tests can be run locally by using `shinytest2::test_app("analytics-dashboard")`. You should do this regularly to check that the tests are passing against the code you are working on.
+Tests can be run locally by using `shinytest2::test_app()`. You should do this regularly to check that the tests are passing against the code you are working on.
 
-The tests use data in the `analytics-dashboard/test/testdata/` folder, to regenerate this data look at the `analytics-dashboard/tests/testdata-generator.R` script.
+The tests use data in the `tests/testdata/` folder, to regenerate this data look at the `tests/testdata-generator.R` script.
 
 GitHub Actions provide CI by running the automated tests on every pull request into the main branch using the `.github/workflows/dashboard-tests.yml` workflow.
+
+### Flagging issues
+
+If you spot any issues with the application, please flag it in the "Issues" tab of this repository, and label as a bug. Include as much detail as possible to help us diagnose the issue and prepare a suitable remedy.
+
+### Making suggestions
+
+You can also use the "Issues" tab in GitHub to suggest new features, changes or additions. Include as much detail on why you're making the suggestion and any thinking towards a solution that you have already done.
+
+### Navigation
+
+In general all `.R` files will have a usable outline, so make use of that for navigation if in RStudio: `Ctrl-Shift-O`.
+
+### Code styling 
+
+The function `styler::style_dir()` will tidy code according to tidyverse styling using the styler package. Run this regularly as our pre-commit hooks will prevent you committing code that isn't tidied. This function also helps to test the running of the code and for basic syntax errors such as missing commas and brackets.
+
+You should also run `lintr::lint_dir()` regularly as lintr will check all pull requests for the styling of the code, it does not style the code for you like styler, but is slightly stricter and checks for long lines, variables not using snake case, commented out code and undefined objects amongst other things.
+
+### Pre-commit hooks
+
+We have some pre-commit hooks set up to help with code quality. These are controlled by the `.hooks/pre-commit.R` file.
+
+## Contact
+
+explore.statistics@education.gov.uk

azure-pipelines.yml

@@ -8,12 +8,6 @@ trigger:
     include:
     - main
 
-  paths:
-    include:
-    - analytics-dashboard/*
-    - azure-pipelines.yml
-    - renv.lock
-
 resources:
   repositories:
     - repository: posit-deploy

global.R

@@ -7,10 +7,6 @@ shhh(library(shiny))
 shhh(library(bsicons))
 shhh(library(shinyWidgets))
 
-# Google analytics
-shhh(library(googleAnalyticsR))
-shhh(library(googleAuthR))
-
 # Data processing
 shhh(library(lubridate))
 shhh(library(dplyr))
@@ -27,10 +23,6 @@ shhh(library(anytime))
 shhh(library(arrow))
 shhh(library(dfeR))
 
-# Scrapey scrapey
-shhh(library(rvest))
-shhh(library(httr))
-
 # Database connection
 shhh(library(dbplyr))
 shhh(library(DBI))
@@ -40,6 +32,15 @@ shhh(library(odbc))
 # Data vis
 shhh(library(plotly))
 
+# Pre-commit hooks and CI
+if ("meaning of life" == "42") {
+  library(lintr)
+  library(styler)
+  library(git2r)
+  library(rsconnect)
+  library(shinytest2)
+}
+
 message("...library calls done, setting up global variables...")
 
 # Global variables ============================================================