Merge pull request #379 from dfe-analytical-services/renvUpdate240710

Renv and guidance update
dfe-analytical-services · Jul 10, 2024 · b1dbe8d · b1dbe8d
2 parents 9f50e05 + e61f641
commit b1dbe8d
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 47 deletions.
diff --git a/DeveloperGuide/LocalSkillsDeveloperGuide.md b/DeveloperGuide/LocalSkillsDeveloperGuide.md
@@ -198,7 +198,10 @@ with the updated versions of the files the dashboard uses.
 
 7.  Run the dashboard: `runApp()`
 
-8.  QA. Create a new QA log in “Analytical Projects\Analysis\S005 LSIP
+8.  Update the shiny tests by running `shinytest2::test_app()` and checking
+    that any newly generated snapshots look as expected.
+
+9.  QA. Create a new QA log in “Analytical Projects\Analysis\S005 LSIP
     dashboard\Documentation\QA”. Follow the structure of one already in
     there. Some checks you may do:
 
@@ -213,7 +216,7 @@ with the updated versions of the files the dashboard uses.
   [here](https://educationgovuk.sharepoint.com/:w:/r/sites/UnitforFutureSkills/Shared%20Documents/Analytical%20Projects/Analysis/S005%20LSIP%20dashboard/Documentation/QA/QA%20plan_Local%20Skills%20dashboard_UFS.docx?d=wa17c64605c7f4a3fb2b8bf35f4bec670&csf=1&web=1&e=Z66Jas)
   for process)
 
-9.  If everything looks ok, commit, push and merge to Development. Wait
+10.  If everything looks ok, commit, push and merge to Development. Wait
     for that to deploy (can take 15mins or more - you can track this in
     [Actions · dfe-analytical-services/lsip_dashboard
     (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)).
@@ -224,7 +227,7 @@ with the updated versions of the files the dashboard uses.
     the live environment:
     <https://department-for-education.shinyapps.io/local-skills-dashboard/>
 
-10. Consider communicating the change to the wider Team or other
+11. Consider communicating the change to the wider Team or other
     stakeholders.
 
 ## I want to add a metric to the dashboard
@@ -259,7 +262,10 @@ To add one of these into the dashboard:
 5.  Run `runApp()` and check the metric is available in the Local Skills
     tab.
 
-6.  QA. Create a new QA log in “Analytical Projects\Analysis\S005 LSIP
+6.  Update the shiny tests by running `shinytest2::test_app()` and checking
+    that any newly generated snapshots look as expected.
+
+7.  QA. Create a new QA log in “Analytical Projects\Analysis\S005 LSIP
     dashboard\Documentation\QA”. Follow the structure of one already in
     there. Some checks you may do:
 
@@ -272,19 +278,19 @@ To add one of these into the dashboard:
     - Check the charts are in the format you want especially looking at
       whether it needs to be a percentage or volume
 
-7.  If everything looks ok, commit, push and merge to Development. Wait
+8.  If everything looks ok, commit, push and merge to Development. Wait
     for that to deploy (can take 15mins or more - you can track this in
     [Actions · dfe-analytical-services/lsip_dashboard
     (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)).
     Again check everything looks ok in the preprod environment:
     <https://department-for-education.shinyapps.io/local-skills-dashboard-preprod/>
 
-8.  If you have done sufficient QA and you are satisfied, merge to Main
+9.  If you have done sufficient QA and you are satisfied, merge to Main
     and wait for that to deploy. Check again everything looks ok in the
     live environment:
     <https://department-for-education.shinyapps.io/local-skills-dashboard/>
 
-9.  Consider communicating the change to the wider Team or other
+10.  Consider communicating the change to the wider Team or other
     stakeholders.
 
 **Optional extras/troubleshooting**
@@ -382,7 +388,10 @@ To add one of these into the dashboard:
 
 11. Run the app `runApp()`.
 
-12. QA. Create a new QA log in “Analytical Projects\Analysis\S005 LSIP
+12.  Update the shiny tests by running `shinytest2::test_app()` and checking
+    that any newly generated snapshots look as expected.
+
+13. QA. Create a new QA log in “Analytical Projects\Analysis\S005 LSIP
     dashboard\Documentation\QA”. Follow the structure of one already in
     there. Some checks you may do:
 
@@ -395,22 +404,22 @@ To add one of these into the dashboard:
     - Check the charts are in the format you want especially looking at
       whether it needs to be a percentage or volume
 
-13. Take a renv snapshot to help future users allign to any packages you
+14. Take a renv snapshot to help future users allign to any packages you
     have changed/added:`renv::snapshot()`
 
-14. If everything looks ok, commit, push and merge to Development. Wait
+15. If everything looks ok, commit, push and merge to Development. Wait
     for that to deploy (can take 15mins or more - you can track this in
     [Actions · dfe-analytical-services/lsip_dashboard
     (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)).
     Again check everything looks ok in the preprod environment:
     <https://department-for-education.shinyapps.io/local-skills-dashboard-preprod/>
 
-15. If you have done sufficient QA and you are satisfied, merge to Main
+16. If you have done sufficient QA and you are satisfied, merge to Main
     and wait for that to deploy. Check again everything looks ok in the
     live environment:
     <https://department-for-education.shinyapps.io/local-skills-dashboard/>
 
-16. Consider communicating the change to the wider Team or other
+17. Consider communicating the change to the wider Team or other
     stakeholders.
 
 **Optional extras/troubleshooting**

diff --git a/DeveloperGuide/LocalSkillsDeveloperGuide.qmd b/DeveloperGuide/LocalSkillsDeveloperGuide.qmd
@@ -130,7 +130,9 @@ This takes about 20 mins. You should see your environment is populated with new,
 
 7.  Run the dashboard: `runApp()`
 
-8.  QA. Create a new QA log in "Analytical Projects\\Analysis\\S005 LSIP dashboard\\Documentation\\QA". Follow the structure of one already in there. Some checks you may do:
+8.  Update the shiny tests by running `shinytest2::test_app()` and checking that any newly generated snapshots look as expected.
+
+9.  QA. Create a new QA log in "Analytical Projects\\Analysis\\S005 LSIP dashboard\\Documentation\\QA". Follow the structure of one already in there. Some checks you may do:
 
 -   Check that your dataset has been updated correctly (by comparing with the version you branched off of and cross checking with the raw data).
 -   Check the Data Sources table has been updated correctly
@@ -163,18 +165,20 @@ To add one of these into the dashboard:
 
 5.  Run `runApp()` and check the metric is available in the Local Skills tab.
 
-6.  QA. Create a new QA log in "Analytical Projects\\Analysis\\S005 LSIP dashboard\\Documentation\\QA". Follow the structure of one already in there. Some checks you may do:
+6.  Update the shiny tests by running `shinytest2::test_app()` and checking that any newly generated snapshots look as expected.
+
+7.  QA. Create a new QA log in "Analytical Projects\\Analysis\\S005 LSIP dashboard\\Documentation\\QA". Follow the structure of one already in there. Some checks you may do:
 
     -   Check that your dataset has been added correctly (by comparing with the version you branched off of and cross checking with the raw data).
     -   Check the Data Sources table has been updated correctly
     -   Check the text in the Local Skills tab makes sense for your updated metric.
     -   Check the charts are in the format you want especially looking at whether it needs to be a percentage or volume
 
-7.  If everything looks ok, commit, push and merge to Development. Wait for that to deploy (can take 15mins or more - you can track this in [Actions · dfe-analytical-services/lsip_dashboard (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)). Again check everything looks ok in the preprod environment: <https://department-for-education.shinyapps.io/local-skills-dashboard-preprod/>
+8.  If everything looks ok, commit, push and merge to Development. Wait for that to deploy (can take 15mins or more - you can track this in [Actions · dfe-analytical-services/lsip_dashboard (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)). Again check everything looks ok in the preprod environment: <https://department-for-education.shinyapps.io/local-skills-dashboard-preprod/>
 
-8.  If you have done sufficient QA and you are satisfied, merge to Main and wait for that to deploy. Check again everything looks ok in the live environment: <https://department-for-education.shinyapps.io/local-skills-dashboard/>
+9.  If you have done sufficient QA and you are satisfied, merge to Main and wait for that to deploy. Check again everything looks ok in the live environment: <https://department-for-education.shinyapps.io/local-skills-dashboard/>
 
-9.  Consider communicating the change to the wider Team or other stakeholders.
+10. Consider communicating the change to the wider Team or other stakeholders.
 
 **Optional extras/troubleshooting**
 
@@ -211,7 +215,7 @@ To add one of these into the dashboard:
     c\. You then need to manipulate your now clean data into the following form:
 
 | Column name | Description                                                                                                            | Format    | Example           |
-|-------------|------------------------------------------------------------------------------------------------------------------------|-----------|-------------------|
+|----------|-------------------------------------------|----------|----------|
 | geogConcat  | Area name and geography                                                                                                | character | Black Country LEP |
 | metric      | Variable of interest                                                                                                   | character | inemployment      |
 | breakdown   | *If* the dataset has a breakdown they are listed here. Every metric **must** have a "Total" as well as any breakdowns. | character | Age               |
@@ -232,20 +236,22 @@ To add one of these into the dashboard:
 
 11. Run the app `runApp()`.
 
-12. QA. Create a new QA log in "Analytical Projects\\Analysis\\S005 LSIP dashboard\\Documentation\\QA". Follow the structure of one already in there. Some checks you may do:
+12. Update the shiny tests by running `shinytest2::test_app()` and checking that any newly generated snapshots look as expected.
+
+13. QA. Create a new QA log in "Analytical Projects\\Analysis\\S005 LSIP dashboard\\Documentation\\QA". Follow the structure of one already in there. Some checks you may do:
 
     -   Check that your dataset has been added correctly (by comparing with the version you branched off of and cross checking with the raw data).
     -   Check the Data Sources table has been updated correctly
     -   Check the text in the Local Skills tab makes sense for your updated metric.
     -   Check the charts are in the format you want especially looking at whether it needs to be a percentage or volume
 
-13. Take a renv snapshot to help future users allign to any packages you have changed/added:`renv::snapshot()`
+14. Take a renv snapshot to help future users allign to any packages you have changed/added:`renv::snapshot()`
 
-14. If everything looks ok, commit, push and merge to Development. Wait for that to deploy (can take 15mins or more - you can track this in [Actions · dfe-analytical-services/lsip_dashboard (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)). Again check everything looks ok in the preprod environment: <https://department-for-education.shinyapps.io/local-skills-dashboard-preprod/>
+15. If everything looks ok, commit, push and merge to Development. Wait for that to deploy (can take 15mins or more - you can track this in [Actions · dfe-analytical-services/lsip_dashboard (github.com)](https://github.com/dfe-analytical-services/lsip_dashboard/actions)). Again check everything looks ok in the preprod environment: <https://department-for-education.shinyapps.io/local-skills-dashboard-preprod/>
 
-15. If you have done sufficient QA and you are satisfied, merge to Main and wait for that to deploy. Check again everything looks ok in the live environment: <https://department-for-education.shinyapps.io/local-skills-dashboard/>
+16. If you have done sufficient QA and you are satisfied, merge to Main and wait for that to deploy. Check again everything looks ok in the live environment: <https://department-for-education.shinyapps.io/local-skills-dashboard/>
 
-16. Consider communicating the change to the wider Team or other stakeholders.
+17. Consider communicating the change to the wider Team or other stakeholders.
 
 **Optional extras/troubleshooting**
 

diff --git a/renv.lock b/renv.lock
@@ -53,14 +53,14 @@
     },
     "KernSmooth": {
       "Package": "KernSmooth",
-      "Version": "2.23-24",
+      "Version": "2.23-22",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R",
         "stats"
       ],
-      "Hash": "9f33a1ee37bbe8919eb2ec4b9f2473a5"
+      "Hash": "2fecebc3047322fa5930f74fae5de70f"
     },
     "MASS": {
       "Package": "MASS",
@@ -193,15 +193,15 @@
     },
     "XML": {
       "Package": "XML",
-      "Version": "3.99-0.16.1",
+      "Version": "3.99-0.17",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R",
         "methods",
         "utils"
       ],
-      "Hash": "da3098169c887914551b607c66fe2a28"
+      "Hash": "bc2a8a1139d8d4bd9c46086708945124"
     },
     "anytime": {
       "Package": "anytime",
@@ -467,14 +467,14 @@
     },
     "cli": {
       "Package": "cli",
-      "Version": "3.6.2",
+      "Version": "3.6.3",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R",
         "utils"
       ],
-      "Hash": "1216ac65ac55ec0058a6f75d7ca0fd52"
+      "Hash": "b21916dd77a27642b447374a5d30ecf3"
     },
     "clipr": {
       "Package": "clipr",
@@ -542,15 +542,15 @@
     },
     "crayon": {
       "Package": "crayon",
-      "Version": "1.5.2",
+      "Version": "1.5.3",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "grDevices",
         "methods",
         "utils"
       ],
-      "Hash": "e8a1e41acf02548751f45c718d55aa6a"
+      "Hash": "859d96e65ef198fd43e82b9628d593ef"
     },
     "crosstalk": {
       "Package": "crosstalk",
@@ -691,14 +691,14 @@
     },
     "digest": {
       "Package": "digest",
-      "Version": "0.6.35",
+      "Version": "0.6.36",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R",
         "utils"
       ],
-      "Hash": "698ece7ba5a4fa4559e3d537e7ec3d31"
+      "Hash": "fd6824ad91ede64151e93af67df6376b"
     },
     "dplyr": {
       "Package": "dplyr",
@@ -1155,7 +1155,7 @@
     },
     "knitr": {
       "Package": "knitr",
-      "Version": "1.47",
+      "Version": "1.48",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
@@ -1167,7 +1167,7 @@
         "xfun",
         "yaml"
       ],
-      "Hash": "7c99b2d55584b982717fcc0950378612"
+      "Hash": "acf380f300c721da9fde7df115a5f86f"
     },
     "labeling": {
       "Package": "labeling",
@@ -1477,24 +1477,25 @@
     },
     "pkgload": {
       "Package": "pkgload",
-      "Version": "1.3.4",
+      "Version": "1.4.0",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R",
         "cli",
-        "crayon",
         "desc",
         "fs",
         "glue",
+        "lifecycle",
         "methods",
         "pkgbuild",
+        "processx",
         "rlang",
         "rprojroot",
         "utils",
         "withr"
       ],
-      "Hash": "876c618df5ae610be84356d5d7a5d124"
+      "Hash": "2ec30ffbeec83da57655b850cf2d3e0e"
     },
     "plotly": {
       "Package": "plotly",
@@ -1623,14 +1624,14 @@
     },
     "ps": {
       "Package": "ps",
-      "Version": "1.7.6",
+      "Version": "1.7.7",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R",
         "utils"
       ],
-      "Hash": "dd2b9319ee0656c8acf45c7f40c59de7"
+      "Hash": "878b467580097e9c383acbb16adab57a"
     },
     "purrr": {
       "Package": "purrr",
@@ -1749,7 +1750,7 @@
     },
     "reprex": {
       "Package": "reprex",
-      "Version": "2.1.0",
+      "Version": "2.1.1",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
@@ -1767,7 +1768,7 @@
         "utils",
         "withr"
       ],
-      "Hash": "1425f91b4d5d9a8f25352c44a3d914ed"
+      "Hash": "97b1d5361a24d9fb588db7afe3e5bcbf"
     },
     "rlang": {
       "Package": "rlang",
@@ -2543,13 +2544,13 @@
     },
     "wk": {
       "Package": "wk",
-      "Version": "0.9.1",
+      "Version": "0.9.2",
       "Source": "Repository",
       "Repository": "CRAN",
       "Requirements": [
         "R"
       ],
-      "Hash": "5d4545e140e36476f35f20d0ca87963e"
+      "Hash": "877644b9b942d429f3708e12c98d1a22"
     },
     "writexl": {
       "Package": "writexl",
@@ -2597,10 +2598,10 @@
     },
     "yaml": {
       "Package": "yaml",
-      "Version": "2.3.8",
+      "Version": "2.3.9",
       "Source": "Repository",
       "Repository": "CRAN",
-      "Hash": "29240487a071f535f5e5d5a323b7afbd"
+      "Hash": "9cb28d11799d93c953f852083d55ee9e"
     },
     "zip": {
       "Package": "zip",

diff --git a/ui.R b/ui.R
@@ -521,7 +521,7 @@ width: 100%;
           div(
             class = "panel-body",
             h2("Latest update"),
-            p("9 Jul 2024 (1.4.2)"),
+            p("10 Jul 2024 (1.4.2)"),
             tags$ul(
               tags$li("Updated job adverts data to latest version including data up to December 2023.")
             ),