Function to initialise google analytics html script

.gitignore

@@ -2,3 +2,4 @@
 .Rhistory
 .RData
 .Ruserdata
+google_analytics.html

DESCRIPTION

@@ -10,9 +10,12 @@ Description: R package containing preferred methods for creating official
     DfE R-Shiny dashboards.
 License: GPL (>= 3)
 Imports: 
+    dplyr,
+    magrittr,
     shiny,
     shinyGovstyle,
     shinyjs,
+    stringr,
     styler
 Suggests: 
     diffviewer,

NAMESPACE

@@ -3,5 +3,7 @@
 export(cookie_banner_server)
 export(cookie_banner_ui)
 export(dfe_cookie_script)
+export(initialise_analytics)
 export(support_panel)
 export(tidy_code)
+importFrom(magrittr,"%>%")

R/initialisers.R

@@ -0,0 +1,108 @@
+#' initialise_analytics
+#'
+#' @param ga_code The Google Analytics code
+#' @importFrom magrittr %>%
+#' @return TRUE if written, FALSE if not
+#' @export
+#'
+#' @examples initialise_analytics(ga_code = "0123456789")
+initialise_analytics <- function(ga_code) {
+  is_valid_ga4_code <- function(ga_code) {
+    stringr::str_length(ga_code) == 10 & typeof(ga_code) == "character"
+  }
+
+  if (is_valid_ga4_code(ga_code) == FALSE) {
+    stop(
+      'You have entered an invalid GA4 code in the ga_code argument.
+      Please enter a 10 digit code as a character string.
+      e.g. "0123QWERTY"'
+    )
+  }
+
+  html_script <- "<script>
+// Define dataLayer and the gtag function.
+window.dataLayer = window.dataLayer || [];
+function gtag(){dataLayer.push(arguments);}
+
+// Default ad_storage to 'denied' as a placeholder
+// Determine actual values based on your own requirements
+gtag('consent', 'default', {
+  'ad_storage': 'denied',
+  'analytics_storage': 'denied'
+});
+</script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src='https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX'></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+
+    gtag('js', new Date());
+
+  gtag('config', 'G-XXXXXXXXXX');
+
+/*
+The custom trackers below can be tailored to match the inputs used in your dashboard.
+*/
+
+  $(document).on('change', 'select#selectPhase', function(e) {
+    gtag('event', 'select phase', {'event_category' : 'choose Phase',
+    'event_label' : document.querySelector('select#selectPhase').value
+    });
+  });
+
+  $(document).on('change', 'select#selectArea', function(e) {
+    gtag('event', 'select area', {'event_category' : 'choose Area',
+    'event_label' : document.querySelector('select#selectArea').value
+    });
+  });
+
+  $(document).on('click', 'ul#navlistPanel', function(e) {
+    gtag('event', 'navlistPanel', {'event_category' : 'navbar click',
+    'event_label' : document.querySelector('ul#navlistPanel > li.active > a').getAttribute('data-value')
+    });
+  });
+
+  $(document).on('click', 'ul#tabsetpanels', function(e) {
+    gtag('event', 'tab panels', {'event_category' : 'tab panel clicks',
+    'event_label' : document.querySelector('ul#tabsetpanels > li.active > a').getAttribute('data-value')
+    });
+  });
+
+
+  $(document).on('click', 'a#download_data', function(e) {
+    gtag('event', 'Download button', {'event_category' : 'Download button click'
+    });
+  });
+
+  $(document).on('shiny:disconnected', function(e) {
+    gtag('event', 'disconnect', {
+      'event_label' : 'Disconnect',
+      'event_category' : 'Disconnect'
+    });
+  });
+
+</script>
+      " %>% gsub("XXXXXXXXXX", ga_code, .)
+  if (file.exists("google-analytics.html")) {
+    message("Analytics file already exists. If you have any customisations in that file, make sure you've backed those up before over-writing.")
+    user_input <- stringr::str_trim(readline(prompt = "Are you happy to overwrite the existing analytics script (y/N) "))
+    if (user_input %in% c("y", "Y")) {
+      write_out <- TRUE
+    } else {
+      write_out <- FALSE
+    }
+  } else {
+    write_out <- TRUE
+  }
+  if (write_out) {
+    cat(html_script, file = "google-analytics.html")
+    message("Google analytics script created in google-analytics.html.")
+    message("You'll need to add the following line to your ui.R script to start
+            recording analytics:")
+    message('tags$head(includeHTML(("google-analytics.html"))),')
+  } else {
+    message("Original Google analytics html script left in place.")
+  }
+}

R/tidy_code.R

@@ -6,7 +6,7 @@
 #' @param subdirs List of sub-directories to
 #' (recursively search for R scripts to be styled)
 #'
-#' @return True or False value based on if scripts were changed
+#' @return TRUE if any changes have been made to any scripts, FALSE if all passed.
 #' @export
 #'
 #' @examples
@@ -15,7 +15,12 @@
   message("----------------------------------------")
   message("App scripts")
   message("----------------------------------------")
-  script_changes <- eval(styler::style_dir(recursive = FALSE)$changed)
+  script_changes <- eval(
+    styler::style_dir(
+      recursive = FALSE,
+      exclude_files = c("dfeshiny-Ex.R")
+    )$changed
+  )
   for (dir in subdirs) {
     if (dir.exists(dir)) {
       message(paste(dir, "scripts"))

README.md

@@ -19,6 +19,21 @@ If this works, then you will need to look for where that "GITHUB_PAT" variable i
 
 ## Using this package in a DfE data dashboard
 
+### Adding analytics to your dashboard
+
+For analytics to function on your dashboard, you will need to:
+
+- request a Google Analytics key from the [Statistics Development Team](mailto:[email protected])
+- create a html file with the javascript required for your dashboard to connect to Google Analytics
+
+To create the latter, we provide the function `dfeshiny::initialise_analytics()`. You should run this code from the R console providing your Google Analytics code as follows:
+
+```
+initialise_analytics("ABCDE12345")
+```
+
+This will create the file [google-analytics.html](google-analytics.html) within the home directory of your R project. This html file can be edited to add customised analytics recorders for different shiny elements in your dashboard. Feel free to contact our team if you need support in adding additional functionality.
+
 ### Adding cookies to your dashboard
 
 dfeshiny provides the facility to add a gov.uk styled cookie banner to your 

google-analytics.html

@@ -0,0 +1,66 @@
+<script>
+// Define dataLayer and the gtag function.
+window.dataLayer = window.dataLayer || [];
+function gtag(){dataLayer.push(arguments);}
+
+// Default ad_storage to 'denied' as a placeholder
+// Determine actual values based on your own requirements
+gtag('consent', 'default', {
+  'ad_storage': 'denied',
+  'analytics_storage': 'denied'
+});
+</script>
+
+<!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src='https://www.googletagmanager.com/gtag/js?id=G-012245trjh'></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+
+    gtag('js', new Date());
+
+  gtag('config', 'G-012245trjh');
+
+/*
+The custom trackers below can be tailored to match the inputs used in your dashboard.
+*/
+
+  $(document).on('change', 'select#selectPhase', function(e) {
+    gtag('event', 'select phase', {'event_category' : 'choose Phase',
+    'event_label' : document.querySelector('select#selectPhase').value
+    });
+  });
+
+  $(document).on('change', 'select#selectArea', function(e) {
+    gtag('event', 'select area', {'event_category' : 'choose Area',
+    'event_label' : document.querySelector('select#selectArea').value
+    });
+  });
+
+  $(document).on('click', 'ul#navlistPanel', function(e) {
+    gtag('event', 'navlistPanel', {'event_category' : 'navbar click',
+    'event_label' : document.querySelector('ul#navlistPanel > li.active > a').getAttribute('data-value')
+    });
+  });
+
+  $(document).on('click', 'ul#tabsetpanels', function(e) {
+    gtag('event', 'tab panels', {'event_category' : 'tab panel clicks',
+    'event_label' : document.querySelector('ul#tabsetpanels > li.active > a').getAttribute('data-value')
+    });
+  });
+
+
+  $(document).on('click', 'a#download_data', function(e) {
+    gtag('event', 'Download button', {'event_category' : 'Download button click'
+    });
+  });
+
+  $(document).on('shiny:disconnected', function(e) {
+    gtag('event', 'disconnect', {
+      'event_label' : 'Disconnect',
+      'event_category' : 'Disconnect'
+    });
+  });
+
+</script>
+

tests/testthat/test-initialise_analytics.R

@@ -0,0 +1,15 @@
+test_that("Blank code throws error", {
+  expect_error(initialise_analytics())
+})
+
+test_that("Long code throws error", {
+  expect_error(initialise_analytics("G-qwertyuiop"))
+})
+
+test_that("Short code throws error", {
+  expect_error(initialise_analytics("qwerty"))
+})
+
+test_that("Numeric throws error", {
+  expect_error(initialise_analytics(1234567890))
+})