From 0064e0aad10dcbf35bf477505088b835eb00aaf4 Mon Sep 17 00:00:00 2001 From: Cam Race <52536248+cjrace@users.noreply.github.com> Date: Wed, 18 Sep 2024 19:27:18 +0100 Subject: [PATCH] EES page tidy up (#100) * fix a couple of team references and all headers so there's no h1's * Rest of little fixes to ees page * Add more details to CSV references * remove jumbotron * initial PR responses * PR tidy up round 2 * Third time's the charm? --- index.qmd | 6 +- statistics-production/ees.qmd | 313 ++++++++++++---------- statistics-production/embedded-charts.qmd | 40 +-- statistics-production/pub.qmd | 24 +- statistics-production/ud.qmd | 46 ++-- writing-visualising/dashboards.qmd | 4 +- 6 files changed, 237 insertions(+), 196 deletions(-) diff --git a/index.qmd b/index.qmd index 4b35d874..cb07e6bb 100644 --- a/index.qmd +++ b/index.qmd @@ -59,7 +59,7 @@ We hope it can prove a useful community driven resource for everyone from the mo - Good practice examples in the explore education statistics service [Embedded visualisations in EES](statistics-production/embedded-charts.html) -- How to embed R-Shiny charts in EES publications +- How to embed R Shiny charts in EES publications [Publication scrums](statistics-production/scrums.html) - Information on the scrums we run and tips for writing statistical commentary @@ -75,8 +75,8 @@ We hope it can prove a useful community driven resource for everyone from the mo [Public dashboards](writing-visualising/dashboards.html) - Guidance for publishing public facing statistics dashboards -[Publishing an R-Shiny based dashboard](writing-visualising/dashboards_rshiny.html) -- Guidance for publishing public facing statistics dashboards using R-Shiny +[Publishing an R Shiny based dashboard](writing-visualising/dashboards_rshiny.html) +- Guidance for publishing public facing statistics dashboards using R Shiny [Visualising data](writing-visualising/visualising.html) - Resources and best practice to guide you when visualising data diff --git a/statistics-production/ees.qmd b/statistics-production/ees.qmd index c2c5ad13..d7f04ea4 100644 --- a/statistics-production/ees.qmd +++ b/statistics-production/ees.qmd @@ -14,15 +14,16 @@ Explore education statistics (EES) is the Department’s official statistics dis 2. The [admin](https://admin.explore-education-statistics.service.gov.uk/) website, where production teams create their stats -Maintenance and use of the platform is supported by the [Statistics Development Team](mailto:explore.statistics@education.gov.uk). +Maintenance and use of the platform is supported by the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk). --- -# Accessing EES +## Accessing EES ---- -## Environments +### Environments + +---
If you are bookmarking links, please be careful to bookmark the links below exactly as they are shown. Often when signing in you will be redirected via other URL's as a part of the authentication process, and bookmarking those may lead to errors. @@ -74,11 +75,13 @@ The pre-production environment is not suitable for unpublished data. Unpublished --- -### Getting access to admin +#### Getting access to admin + +--- -Access to both the production and pre-production admin services is limited to DfE AD accounts only and users have to have been invited to the service by either the Statistics Development Team (for full access) or an existing user (for pre-release access). Invites to the service are sent out via email using gov.uk Notify. +Access to both the production and pre-production admin services is limited to DfE AD accounts only and users have to have been invited to the service by either the explore education statistics platforms team (for full access) or an existing user (for pre-release access). Invites to the service are sent out via email using GOV.UK Notify. -To be invited to the service for full access teams need to email the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk), stating who needs access, what permissions they require (analyst or approver), and for which publications these apply. This email should be sent by the Team Leader, or accompanied with the relevant Team Leader’s approval. Once access has been granted you will receive an email inviting you to use the platform. +To be invited to the service for full access teams need to email the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk), stating who needs access, what permissions they require (analyst or approver), and for which publications these apply. This email should be sent by the Team Leader, or accompanied with the relevant Team Leader’s approval. Once access has been granted you will receive an email inviting you to use the platform.
Jobshare emails can not be used to access EES. Specific personal emails should be used instead, in the same way as you sign in to windows on your machine. @@ -87,10 +90,11 @@ Jobshare emails can not be used to access EES. Specific personal emails should b --- -## Roles and permissions +### Roles and permissions +--- -The Statistics Development Team are responsible for setting up and maintaining user permissions during the beta phase. Change requests will be monitored via the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk). +The Statistics Development Team are responsible for setting up and maintaining user permissions during the beta phase. Change requests will be monitored by the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk). The following roles exist within EES admin and are assigned to a specific release: @@ -174,8 +178,9 @@ To change Publication Owners, or Approvers, contact the [explore education stati --- -## Requesting a new publication +### Requesting a new publication +--- If you have not published on EES before, or if you're creating a brand new publication, you will need to contact us to create the publication for you before you can get started. @@ -191,7 +196,7 @@ If you want to request a new publication, please be prepared to provide us with * Badging (whether they are National statistics, an ad-hoc publication, or official statistics) * Who needs access to the publication (list of email addresses of analysts who need access to the release and at what [permission levels](#roles-and-permissions)) -Publication details can be [managed by publication owners](#managing-publications) or via requests to the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk). +Publication details can be [managed by publication owners](#managing-publications) or via requests to the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk). The hierarchy of content within EES is as follows: @@ -199,8 +204,11 @@ The hierarchy of content within EES is as follows: Methodology documentation is attached at a publication level within EES - meaning one standalone piece should be written to cover all releases for the given publication within the service. +--- -### Themes +#### Themes + +--- Publications are organised into themes (as shown on the EES [Find Statistics page](https://explore-education-statistics.service.gov.uk/find-statistics)), and then within each publication there are releases - where the latest release includes the latest statistics for that publication. @@ -214,7 +222,7 @@ For example: --- -### Publication summaries +#### Publication summaries --- @@ -240,8 +248,9 @@ You only have 160 characters – to make sure you are fully utilising these, hav --- -## Admin dashboard +### Admin dashboard +---
Use Google Chrome or Microsoft Edge to access and use the admin part of the explore education statistics service. @@ -257,14 +266,18 @@ Within the admin dashboard you can view and manage existing publications, includ --- -## External user access +### External user access + +--- +It is possible to request that external users from other government organisations have access, and they can then be added as collaborating analysts on a release or as pre-release viewers. Each external user must complete a declaration form. When you email the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk) to request external user access, you should attach copies of the declaration forms for each external user. Temporary external accounts are usually set up to expire after three months, with an option to extend this if required. + +--- -It is possible to request that external users from other government organisations have access, and they can then be added as collaborating analysts on a release or as pre-release viewers. Each external user must complete a declaration form. When you email the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk) to request external user access, you should attach copies of the declaration forms for each external user. Temporary external accounts are usually set up to expire after three months, with an option to extend this if required. +#### Adding external users as pre-release viewers --- -### Adding external users as pre-release viewers This process has two distinct steps: getting a temporary account set up per user in the DfE Azure Active Directory, and then adding lists of users requiring pre-release access (PRA) onto EES itself. The diagram below shows the responsibilities of the publication team, the Statistics Development Team, and the Identity Access Management Team in this process:
@@ -272,7 +285,9 @@ This process has two distinct steps: getting a temporary account set up per user --- -### Adding external users as collaborating analysts +#### Adding external users as collaborating analysts + +--- The process for adding external users as collaborating analysts is similar to adding external users for PRA, except for the final step, in which the Statistics Development Team add the external users via the EES admin interface. The process can be seen in the diagram below: @@ -281,21 +296,28 @@ The process for adding external users as collaborating analysts is similar to ad --- -### What to include in an external access request +#### What to include in an external access request + +--- -If you have external users you'd like to request access for, please send the following details to the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk), **at least two weeks** in advance of requiring access, but ideally as early as possible. Due to the dependency on DfE's digital security, we cannot guarantee access or how long it may take. +If you have external users you'd like to request access for, please send the following details to the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk) * Email addresses of users to be added * Reason for access * Length of time access is needed (the standard time period is three months) * Copies of declaration forms for each user ---- +:::{.callout-important} + +You need to contact us **at least two weeks** in advance of requiring access, but ideally as early as possible. Due to the dependency on DfE's digital security, we cannot guarantee access or how long it may take. -# Creating releases +::: --- +## Creating releases + + New releases can be [created by publication owners](#create-new-release). To create a new release in a publication series, navigate to the relevant publication and click 'Create new release', you will then need to enter the following information: * [Time identifier](../statistics-production/ud.html#list_of_allowable_time_values) for the release @@ -319,12 +341,13 @@ Once you have created your release you will see the dashboard to edit your relea ![](../images/EES-create-release-dashboard.PNG) -If you are experiencing issues or need help with creating a new release, you can get in touch with the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk). +If you are experiencing issues or need help with creating a new release, you can get in touch with the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk). --- -## Data and files +### Data and files +--- You need to make sure that the data files and accompanying [metadata](../statistics-production/ud.html#ees-metadata) have passed through our [data screener checks](https://rsconnect/rsc/dfe-published-data-qa/) before trying to upload it. @@ -336,7 +359,7 @@ Releases cannot be published without a completed metadata document. If not fille --- -### Subject titles +#### Subject titles --- @@ -373,7 +396,7 @@ For data files greater than 80mb we recommend uploading as a ZIP file. Once you click to upload the file a ‘Status’ will be visible that shows the progress of the import process. This may take a little while depending on the size of your file and if there are numerous files queued for import. You cannot view the dataset or use it to create tables/charts until this status is ‘COMPLETE’. -If you are having any issues uploading a file, please contact explore.statistics@education.gov.uk. +If you are having any issues uploading a file, please contact the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk). --- @@ -417,7 +440,7 @@ If anything in this ZIP folder doesn't match up with this, you will receive an e --- -### Ordering filters and indicators +#### Ordering filters and indicators --- @@ -433,87 +456,88 @@ This then becomes the default order for this filter or indicator and will apply ![](../images/order-filters-indicators.png) - --- -### Supporting file uploads +### Replacing data --- -Supporting files should not be used as the default. Wherever possible you should upload your data as data files that can then be used in the table tool. - -Any files you want to make available for users to download but aren't intended for the table tool should be added as a supporting file upload. These files will need to meet all requirements of the new [accesibility regulations](https://www.gov.uk/guidance/publishing-accessible-documents) before they can be published. +If you just need to change the [Subject titles](#subject-titles) for your data file(s) you do not need to go through the whole replacement process, just click the 'Edit title' option. -Examples of supporting files may be: +However, if you notice a mistake in your data file you can replace it with another. When replacing a data file the platform will attempt to recreate any data blocks and footnotes that were built using the previous file. -* Infographic pages -* Supplementary data that isn't intended for the table tool +
+The replacement file must contain the exact same column names and types as the original. For example, a character column named "date" must also be replaced with a character column named "date". A numeric column named "date" will not work in the replacement. +
-To ensure that spreadsheets are accessible, see the guidance from [gov.wales](https://gov.wales/how-create-accessible-excel-spreadsheets), and this [Analysis Function guidance](https://analysisfunction.civilservice.gov.uk/policy-store/making-analytical-publications-accessible/). +Navigate to the file you wish to replace, and you should see a 'Replace data' option in the 'Actions' row. -If you are unsure of whether you should be using supporting files, contact the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk) for advice. +![](../images/replace-data-start.png) ---- +The first step is to upload the new file. -### Public data guidance +![](../images/replace-data-step1.PNG) ---- +Once you've chosen and uploaded your replacement file it will need to go through the usual import process before it can check if retaining existing data blocks and footnotes will be possible. -Within the 'Data and files' page, you can also create your public data guidance. This replaces the information that would have previously been uploaded as a pdf on GOV.UK and is designed to help users understand and use the data they download from your release. See the [Permanent and fixed period exclusions data guidance](https://explore-education-statistics.service.gov.uk/find-statistics/permanent-and-fixed-period-exclusions-in-england/meta-guidance) for an example. +![](../images/replace-data-step2.PNG) -The 'Data files' section of the document will automatically update as you add new data files to your release, however you will need to add an overview of all the data included in the release and short summaries for each data file before the release can be published. +Once the upload is finished a report will appear which highlights whether existing data blocks and footnotes can be replaced successfully. If you want to keep any data blocks and footnotes you've built you will need to make sure that your replacement data file still contains the information (indicators, filters, geographic_levels and time_periods) that was used to create them. -![](../images/admin-public-meta-start.PNG) +![](../images/replace-data-success.PNG) -A list of variables in each file with an associated label (taken from metadata uploads) and associated footnotes will also be displayed for each file. +If it's not possible for a data block or footnote to be recreated using the replacing data file a warning will appear and you'll be prompted to either edit or delete them before completing the replacement. -![](../images/admin-public-meta-detail.PNG) +![](../images/replace-data-fail.PNG)
-Releases cannot be published without a completed data guidance. If not filled in an error will be flagged during sign off. +Remember to double check any data blocks or footnotes that were recreated by the platform before publishing your release.
--- -### Replacing data +### Supporting file uploads --- -If you just need to change the [Subject titles](#subject-titles) for your data file(s) you do not need to go through the whole replacement process, just click the 'Edit title' option. +Supporting files should not be used as the default. Wherever possible you should upload your data as data files that can then be used in the table tool. -However, if you notice a mistake in your data file you can replace it with another. When replacing a data file the platform will attempt to recreate any data blocks and footnotes that were built using the previous file. +Any files you want to make available for users to download but aren't intended for the table tool should be added as a supporting file upload. These files will need to meet all requirements of the new [accessibility regulations](https://www.gov.uk/guidance/publishing-accessible-documents) before they can be published. -
-The replacement file must contain the exact same column names and types as the original. For example, a character column named "date" must also be replaced with a character column named "date". A numeric column named "date" will not work in the replacement. -
+Examples of supporting files may be: -Navigate to the file you wish to replace, and you should see a 'Replace data' option in the 'Actions' row. +* Infographic pages +* Supplementary data that isn't intended for the table tool -![](../images/replace-data-start.png) +To ensure that spreadsheets are accessible, see the guidance from [gov.wales](https://gov.wales/how-create-accessible-excel-spreadsheets), and this [Analysis Function guidance](https://analysisfunction.civilservice.gov.uk/policy-store/making-analytical-publications-accessible/). -The first step is to upload the new file. +If you are unsure of whether you should be using supporting files, contact the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk) for advice. -![](../images/replace-data-step1.PNG) +--- -One you've chosen and uploaded your replacement file it will need to go through the usual import process before it can check if retaining existing data blocks and footnotes will be possible. +### Public data guidance -![](../images/replace-data-step2.PNG) +--- -Once the upload is finished a report will appear which highlights whether existing data blocks and footnotes can be replaced successfully. If you want to keep any data blocks and footnotes you've built you will need to make sure that your replacement data file still contains the information (indicators, filters, geographic_levels and time_periods) that was used to create them. +Within the 'Data and files' page, you can also create your public data guidance. This replaces the information that would have previously been uploaded as a PDF on GOV.UK and is designed to help users understand and use the data they download from your release. See the [Permanent and fixed period exclusions data guidance](https://explore-education-statistics.service.gov.uk/find-statistics/permanent-and-fixed-period-exclusions-in-england/meta-guidance) for an example. -![](../images/replace-data-success.PNG) +The 'Data files' section of the document will automatically update as you add new data files to your release, however you will need to add an overview of all the data included in the release and short summaries for each data file before the release can be published. -If it's not possible for a data block or footnote to be recreated using the replacing data file a warning will appear and you'll be prompted to either edit or delete them before completing the replacement. +![](../images/admin-public-meta-start.PNG) -![](../images/replace-data-fail.PNG) +A list of variables in each file with an associated label (taken from metadata uploads) and associated footnotes will also be displayed for each file. + +![](../images/admin-public-meta-detail.PNG)
-Remember to double check any data blocks or footnotes that were recreated by the platform before publishing your release. +Releases cannot be published without a completed data guidance page. If not filled in an error will be flagged during sign off.
--- -## Footnotes +### Footnotes + +--- We generally advise against using footnotes, unless they're absolutely necessary (think about how many people will actually be reading them!). However, if you do want to add footnotes to your data, this should be done using the EES footnote function and **not** added in-text. @@ -535,8 +559,9 @@ We recommend that you only add footnotes once you are certain the data file is f --- -## Data blocks (tables and charts) +### Data blocks (tables and charts) +--- A data block is a smaller cut of data from your original file that you can embed into your publication as a presentation table, build charts from, and link users directly to. @@ -546,11 +571,11 @@ The 'Data blocks' tab will list all the data blocks you have created, highlighti --- -### Using data blocks effectively +#### Using data blocks effectively --- -**Aim for fewer tables, and keep them small. As a guide, we suggest no more than one table per accordion section.** +**Aim for fewer tables, and keep them small. As a guide, we suggest no more than a couple of tables per accordion section.** Presentation tables are the tables you include within the accordion sections of your release to quickly visualise numbers. Unlike the underlying data files, the presentation tables focus on specific parts of the story you are telling. They are distinct from, and should never be a copy of an underlying data file. @@ -579,7 +604,7 @@ You will be taken through 4 steps to create the data block: 3. Time period: select which time periods you want to include 4. Indicators / Filters: select the indicators and filters to be included -![](../images/ees-create-data-block.PNG) +![](../images/ees-create-data-block.png) Once you have configured the data source for the data block, you can then preview the table displaying the chosen variables. @@ -812,7 +837,7 @@ When selected, you will then see that this data appears in the chart as if the i --- -You should only use complex charts where there is a clear user need, as simple charts are the easiest for users to understand. If you have a an infographic or a chart that is too complex to build within our chart builder you can use the 'Choose an infographic as alternative' option to upload an image to your data block or use the **Add embed block** feature to embed an R-Shiny based plot (see the section on [embedded blocks](embedded-charts.html) for further information). +You should only use complex charts where there is a clear user need, as simple charts are the easiest for users to understand. If you have a an infographic or a chart that is too complex to build within our chart builder you can use the 'Choose an infographic as alternative' option to upload an image to your data block or use the **Add embed block** feature to embed an R Shiny based plot (see the section on [embedded blocks](embedded-charts.html) for further information). Infographic alternatives should be .svg format and you can use the sizing options within the data block editor to size your image appropriately. @@ -830,7 +855,7 @@ Accessibility matters for infographics too, consider the following if you do nee You can use R to create infographics and the following code gives an example of how to create a basic line chart or stacked bar chart using the appropriate GSS sequential colour palette. -``` +``` {r example_ees_r_plot, eval=FALSE} # Load the necessary libraries library(ggplot2) library(dplyr) @@ -893,8 +918,23 @@ The above code should produce something along the lines of the following plots: --- -## Content +#### Embedding R Shiny blocks + +--- + +If you need to include a type of chart that isn't possible using the standard EES chart options, for example an interactive chart with filters, you can embed a block to display a custom R Shiny produced chart. + +To embed an R Shiny chart, you'll first need to create an R Shiny application containing the chart using the DfE tiny-shiny template and get it hosted on our DfE GitHub and ShinyApps accounts. More details on both of these are available in the tiny-shiny section of this guidance. + +Once you've got the R Shiny app set up and hosted, you can embed it using the **Add embed block** button in the content area. This will give you the option to enter a URL, where you can enter the URL of the shiny app. Valid URLs to use in the embed block dialogue box are limited to only those on the DfE ShinyApps server (and the internal POSIT Connect servers when needed for draft publications). + +![The EES interface for embedding a Shiny chart](../images/tinyshiny-ees-block.PNG) + +--- + +### Content +--- In the content tab you can now start creating your release, embedding the data blocks you’ve created as you go. @@ -906,7 +946,11 @@ Add any headline and/or key stats and figures for your release in the headline f You can then create accordion sections to start adding your main release commentary. These sections are made up of text blocks and data blocks which can be reordered as needed. -### Headline facts and figures +--- + +#### Headline facts and figures + +--- Use the ‘Add secondary stats’ button to add a data block to your headline stats section. @@ -927,17 +971,17 @@ After embedding a key stat tile you can then edit it to add trend information an --- -### Accordion section content +#### Accordion section content --- -You should split your release into sections that each focus on one or two key messages, with a recommended maximum of 10 sections in the release. **The whole release should take no more than 10 minutes to read.** Our [analytics app](https://rsconnect/rsc/ees-analytics/){target="_blank" rel="noopener noreferrer"} contains insights on how long it takes the average user to read your release. +You should split your release into sections that each focus on one or two key messages, with a recommended maximum of 10 sections in the release. The whole release should take **no more than 10 minutes to read.** Our [analytics app](https://rsconnect/rsc/ees-analytics/){target="_blank" rel="noopener noreferrer"} contains insights on how long it takes the average user to read your release. To keep the release short only include information if there is something interesting to say - the commentary is there to tell a story, people looking for specific figures will use the table tool, or download the underlying data instead. **Do not try to summarise every number in the commentary.** -Avoid having large blocks of text as they are hard to read and users scan them and miss the detail. Graphs and tables break up the content but only include these where they add value; **you do not need a graph or chart in every section.** +Avoid having large blocks of text as they are hard to read and users scan them and miss the detail. Graphs and tables break up the content but only include these where they add value; you do not need a graph or chart in every section. -Use plain English and shorter sentences, aim for an average of 15-20 words per sentence. Do not overload sentences with numbers and avoid 'elevator commentary' that describes small movements in the whole series without giving any insight (use a summary table instead if it is interesting, or leave it out entirely). **Be impartial and objective; avoid using sensationalist terms or terms that reflect a judgement such as "very few" "only" or "strong".** +Use plain English and shorter sentences, aim for an average of 15-20 words per sentence. Do not overload sentences with numbers and avoid 'elevator commentary' that describes small movements in the whole series without giving any insight (use a summary table instead if it is interesting, or leave it out entirely). Be impartial and objective; avoid using sensationalist terms or terms that reflect a judgement such as "very few" "only" or "strong". Explain complex concepts in plain English within the text. Remember that for many of our users, confidence intervals and significant differences are complex concepts that need explaining. @@ -982,7 +1026,7 @@ Any data tables should be included as data blocks, however, there might be some Navigate to the 'Content' tab. In the text editor, you can add in a table using the table icon. -![](../images/ees-table-in-content.PNG) +![](../images/ees-table-in-content.png)
@@ -991,7 +1035,7 @@ Remember that *all of the data* included or referred to in your content should b --- -### Writing about characteristics +#### Writing about characteristics --- @@ -1006,7 +1050,7 @@ You can also get in touch with the DfE Data Harmonisation Champions Group via [e --- -### Writing about ethnicity +#### Writing about ethnicity --- @@ -1023,7 +1067,7 @@ We recommend ordering ethnic groups either alphabetically, or in expected order --- -### Footnotes +#### Footnotes --- @@ -1031,13 +1075,6 @@ We recommend ordering ethnic groups either alphabetically, or in expected order Do not use footnotes in the text of your content. They’re designed for reference in print, not web pages. If the information in the footnotes is important, include it in the body text. If it’s not, leave it out.
- ---- - -#### Footnotes for tables in content - ---- - If you are including a table in text that needs footnotes, it's generally advised to include this in the commentary surrounding the table. However, if you think a footnote is still necessary, then we advise writing out the word ‘note’, with the number of the note you need to refer to, and put it in square brackets, for example: ‘Number of people in employment [note 1]’. For more guidance on footnotes outside of EES, see the [Analysis Function guidance on symbols, footnotes and codes](https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/#section-6). --- @@ -1058,8 +1095,9 @@ When someone is editing a text box, it will now be instantly frozen for all othe --- -## Getting found online +### Getting found online +--- Search engine optimisation (SEO) makes it easier for users to find your data through search engines like Google. Some top tips include: @@ -1077,40 +1115,26 @@ We should make a concerted effort to ensure that we are answering the questions ![](../images/google-peopleAlsoAsk.png) - --- -## Embedding R-Shiny blocks - - -If you need to include a type of chart that isn't possible using the standard EES chart options, for example an interactive chart with filters, you can embed a block to display a custom R-Shiny produced chart. - -To embed a shiny chart, you'll first need to create an R-Shiny application containing the chart using the DfE tiny-shiny template and get it hosted on our DfE GitHub and ShinyApps accounts. More details on both of these are available in the tiny-shiny section of this guidance. - -Once you've got the R-Shiny app set up and hosted, you can embed it using the **Add embed block** button in the content area. This will give you the option to enter a URL, where you can enter the URL of the shiny app. Valid URLs to use in the embed block dialogue box are limited to only those on the DfE ShinyApps server (and the internal rsconnect when needed for draft publications). - -![The EES interface for embedding a Shiny chart](../images/tinyshiny-ees-block.PNG) - - +### Glossary --- -## Glossary - The [glossary in the explore education statistics service](https://explore-education-statistics.service.gov.uk/glossary) is a growing page that helps us to standardise how refer to key terms and phrases across all of Official statistics. --- -### Adding new definitions +#### Adding new definitions --- -Contact us at explore.statistics@education.gov.uk, with the title and definition and we can add this for you. It's worth having a check on the glossary for similar or related terms, and whether you should be looking to harmonise with other teams. +[Contact the explore education statistics platforms team](mailto:explore.statistics@education.gov.uk), with the title and definition and we can add this for you. It's worth having a check on the glossary for similar or related terms, and whether you should be looking to harmonise with other teams. --- -### Linking to definitions +#### Linking to definitions --- @@ -1124,7 +1148,7 @@ You can test this works by typing the url into your browser, it should take you --- -### Linking from your release +#### Linking from your release --- @@ -1149,10 +1173,11 @@ That's it, the system will automatically recognise that the link is for the glos --- -## Sign off +### Sign off +--- -Once you’re happy with your release you need to go to the sign off page and change it’s status in order to move it through the release pipeline. +Once you’re happy with your release you need to go to the sign off page and change its status in order to move it through the release pipeline. There are three statuses: @@ -1167,7 +1192,7 @@ Only users with [approver](#roles-and-permissions) permissions (usually G6 or ab --- -### Errors and warnings +#### Errors and warnings --- @@ -1181,7 +1206,7 @@ Remember to check over it before you submit your release for approval as a relea --- -### How to approve a release +#### How to approve a release --- @@ -1198,7 +1223,7 @@ This page also gives you the expected release url which may be useful to know fo --- -### Next release expected +#### Next release expected --- @@ -1216,9 +1241,14 @@ Prior to each release going live the production team are also able to grant pre- This preview is only accessible for the 24 hours before the publication date, although the emails may go out to users before then. We expect teams will continue to send an email at 09:30 on pre-release day, including any additional briefing and the link to the pre-release area. +--- + ### Granting pre-release access + +--- +
-Jobshare emails and shared mailboxes should not be sent invites for pre-release. The personal emails for the specific individuals should be used instead, as jobshare emails/shared mailboxes do not have active accounts with DfE to access EES. +Jobshare emails and shared mailboxes should not be sent invites for pre-release. The personal emails for the specific individuals should be used instead, as jobshare emails / shared mailboxes do not have active accounts with DfE to access EES.
@@ -1240,7 +1270,12 @@ Once the release has been marked as approved, go to the ‘Pre-release access ![](../images/EES-invite-pra.PNG) +--- + ### Public pre-release access lists + +--- + You should also create the public facing pre-release access page by clicking the ‘Public access list’ tab.
@@ -1256,11 +1291,10 @@ After creating your pre-release access list a text editor will appear where you --- -# Release amendments +## Making amendments ---- -If you need to make an amendment to release that has already been published this is possible to do from within the admin dashboard if you are a publication owner. If you need to create an amendment and your publication owner is not available, please contact the [Explore Statistics mailbox](mailto:explore.statistics@education.gov.uk) to do this for you. +If you need to make an amendment to release that has already been published this is possible to do from within the admin dashboard if you are a publication owner. If you need to create an amendment and your publication owner is not available, please contact the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk) to do this for you. First, find your publication in the [admin dashboard](#admin-dashboard). @@ -1273,8 +1307,9 @@ Then, from the releases tab, select to 'amend' the release you want to make a ch --- -## Release notes +### Release notes +--- When publishing a new amendment you should add a 'release note' to your release so users can be informed of what has changed. Try to keep this brief while remaining informative - it's important to include detail of what has changed, so that a user can see if there is any data they are interested in has changed. @@ -1287,9 +1322,8 @@ See our guidance on Good examples in EES for a [best practice example of a publi --- -# Methodology +## Methodology ---- Appropriate methodological information must be made available for all published Official Statistics releases. Methodologies can follow our recommended [methodology template](../resources/Methodology template EES.docx), to ensure all the essential details are covered. @@ -1305,17 +1339,23 @@ Once the drafting has finished, a methodology should be set as 'approved for pub Any approved methodology changes will be published immediately so make sure you are ready for the changes to go live before approving.
-## Methodology amendments +--- + +### Methodology amendments + +--- + If you want to revise an existing methodology page you can amend the methodology which will generate a new version for you to edit. -![](../images/amend-methodology-new.PNG) +![](../images/amend-methodology-new.png) Once you're happy with your amendment it just needs to be [approved](#sign-off) in the usual way for it to be published. --- -## Methodology subheadings +### Methodology subheadings +--- Subheadings make it easier for your users to navigate through your methodology. When editing text blocks in your methodology, you can do this by highlighting your subheading and selecting "Heading 3" in place of "Paragraph": @@ -1325,8 +1365,9 @@ You can add further subheadings underneath this but try to limit the number of s --- -## Methodology images +### Methodology images +--- You can add images to methodology pages via the content editor. @@ -1351,9 +1392,8 @@ Accessibility matters for uploaded images too, consider the following if you do --- -# Managing publications +## Managing publications ---- We have a type of role within EES admin called ‘Publication Owner’. This permissions level gives publication owners control over their publications. @@ -1362,8 +1402,9 @@ See [roles and permissions](#roles-and-permissions) to see what options are avai --- -## Publication management +### Publication management +--- Use this page to change the details for your publication, such as the contact information or to add links to legacy releases on gov.uk. @@ -1377,20 +1418,21 @@ It is possible to change the publication title via this page, however this shoul --- -## Create new release +### Create new release +--- After finding the publication you want to create a release for, just press the button to create a new release. Currently the following types of release can be created in EES: -* National Statistics (includes OSR tick mark logo at the top of the release page) -* Official Statistics -* Adhoc Statistics -* Management Information -* Experimental Statistics +* Accredited official statistics (includes OSR tick mark logo at the top of the release page) +* Official statistics +* Ad hoc statistics +* Management information +* Official statistics in development -When creating a release you will be asked to fill in some release summary fields. +When creating a release you will be asked to fill in some release summary fields. If you are unsure of what type of release you are publishing, please contact the [statistics HoP office](mailto:hop.statistics@education.gov.uk) for advice immediately.
The time period for the release should reflect the time period of the data that this latest release adds to the time series. @@ -1398,13 +1440,12 @@ The time period for the release should reflect the time period of the data that --- -## Managing legacy releases +### Managing legacy releases +--- Past publications on other services can be added to the previous releases links that appear on the top right of a release page by using the 'Manage legacy releases' section. In here you can add links to previous releases and choose the order in which they appear. This section can be found by publication owners in the publication management section. - - --- diff --git a/statistics-production/embedded-charts.qmd b/statistics-production/embedded-charts.qmd index 550bf427..bae52bb7 100644 --- a/statistics-production/embedded-charts.qmd +++ b/statistics-production/embedded-charts.qmd @@ -2,15 +2,14 @@ title: "Embedded visualisations in EES" --- -

Guidance for creating and embedding R-Shiny visualisations in EES publications

+

Guidance for creating and embedding R Shiny visualisations in EES publications

--- -# Introduction +## Introduction ---- -EES now offers the option to add an embedded block, which allows analysts to present custom R created charts within their publications. This necessitates analysts creating an R-Shiny based app on GitHub containing the required chart that can then be hosted on a shiny server (currently using the DfE's account on shinyapps.io). +EES now offers the option to add an embedded block, which allows analysts to present custom R created charts within their publications. This necessitates analysts creating an R Shiny based app on GitHub containing the required chart that can then be hosted on a Shiny server (currently using the DfE's account on shinyapps.io). **Note that this current combination of GitHub and ShinyApps for publishing Shiny Apps does not offer the appropriate security required for unpublished DfE data. Unpublished uderlying app data should therefore never be uploaded to GitHub / ShinyApps.io until such time as it has been published (i.e. via EES).** @@ -25,8 +24,9 @@ We are currently putting in place a case to provide an internal shiny server pla --- -## When to use an embedded chart +### When to use an embedded chart +--- EES provides a wide range of inbuilt chart options and will always be the first preference for static line, bar and geographical charts. This helps us to clearly maintain consistent styling and accessibility levels across the site. @@ -37,23 +37,24 @@ However, there are some instances where you might want to publish something that --- -## Tools +### Tools +--- -We currently only support custom charts created using R-Shiny. These should be created with ggplot and plotly. We provide a template example of a demo R-Shiny/ggplot chart on the DfE Analytical Services GitHub site, which is described [below](#the-dfe-tiny-shiny-template). +We currently only support custom charts created using R Shiny. These should be created with ggplot and plotly. We provide a template example of a demo R Shiny / ggplot chart on the DfE Analytical Services GitHub site, which is described [below](#the-dfe-tiny-shiny-template). --- -## Review and authorisation +### Review and authorisation +--- To get a custom chart approved for embedding within a publication, you'll need to get it reviewed by the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk) (in addition to your standard approval chain). --- -# Creating an embeddable R-Shiny App +## Creating an embeddable R Shiny App ---- An embedded chart should take the form of a single chart, with necessary input options and nothing else. Avoid incorporating: @@ -67,8 +68,9 @@ Other elements such as tables may also be possible if there's a clear use case f --- -## The DfE Tiny-Shiny template +### The DfE Tiny-Shiny template +--- Our [template tiny shiny app repository](https://github.com/dfe-analytical-services/dfe-tiny-shiny) should be used a starting point for all embedded shiny charts. @@ -76,8 +78,9 @@ To get an app set-up for use with EES, you'll need the [explore education statis --- -## What's in the template +### What's in the template +--- The template provides code for some basic interactive plots. Each example plot is contained with one of the existing branches below for demonstration purposes: @@ -86,22 +89,22 @@ The template provides code for some basic interactive plots. Each example plot i --- -## Working with data +### Working with data +--- As with the full dashboards, the embedded charts currently require the underlying data to be either included within the app repository on GitHub or uploaded elsewhere publicly accessible such as Google Drive or Dropbox. This currently means that any embedded charts being developed will need to use either dummy data or previously published data until the moment of publication. At the point of the parent release going live, the chart can then be updated with the latest data. Do not upload unpublished data to GitHub, Google Drive or Dropbox. As described earlier, where you need to use unpublished data in your chart prior to publication, you can either a) run the chart locally in R-Studio (without pushing the unpublished data to GitHub) or b) create a DevOps/rsconnect deploy of your app, which can be temporarily used as the embed block URL. Note, this will need updating to a URL to the public dashboard on ShinyApps ready for publication. -We are currently developing a route to allow charts via R-Shiny apps to be hosted on DfE servers, such that draft publications will be able to incorporate embedded charts with the unpublished data. The data itself will then be accessed either from a SQL database on DfE servers. +We are currently developing a route to allow charts via R Shiny apps to be hosted on DfE servers, such that draft publications will be able to incorporate embedded charts with the unpublished data. The data itself will then be accessed either from a SQL database on DfE servers. --- -# Development requirements +## Development requirements ---- -Many of the same principles that apply to creating a full R-Shiny dashboard apply to creating a custom embeddable charts. These are: +Many of the same principles that apply to creating a full R Shiny dashboard apply to creating a custom embeddable charts. These are: * [Accessibility](dashboards.html#accessibility-testing); * [Reliability](dashboards.html#testing-r-shiny); @@ -110,8 +113,9 @@ Many of the same principles that apply to creating a full R-Shiny dashboard appl --- -## Specific design recommendations for embedded plots +### Specific design recommendations for embedded plots +--- Example code for producing an embeddable shiny chart is given in the [template tiny shiny app repository](https://github.com/dfe-analytical-services/dfe-tiny-shiny/server.R). The following recommendations should be followed in adapting this code: diff --git a/statistics-production/pub.qmd b/statistics-production/pub.qmd index 4eca6a95..8a2a2f04 100644 --- a/statistics-production/pub.qmd +++ b/statistics-production/pub.qmd @@ -13,19 +13,19 @@ title: "Routes for publishing" --- -[Explore education statistics](https://explore-education-statistics.service.gov.uk/){target="_blank" rel="noopener noreferrer"} (EES) is the Department's new dissemination platform, designed to make DFE’s published statistics and data easier to find, access, use and understand. +[Explore education statistics](https://explore-education-statistics.service.gov.uk/){target="_blank" rel="noopener noreferrer"} (EES) is the Department's statistics dissemination platform, designed to make DfE’s published statistics and data easier to find, access, use and understand. -The platform moved into Public Beta in March 2020 and currently operates in parallel with existing statistics pages on gov.uk as publications are moved to the new platform. +The platform moved into Public Beta in March 2020 and is the home of all published official statistics from DfE. Some management information is also made available on the service too. -More information on why EES was introduced and the functionality within the platform can be found in these [slides.](https://docs.google.com/presentation/d/1CJMLxEPngGbTZbn1n4M6huGIeizUmjysthLwU3Zxoq4/edit?usp=sharing){target="_blank" rel="noopener noreferrer"} +More information on why EES was introduced and the functionality within the platform can be found in these [slides](https://docs.google.com/presentation/d/1CJMLxEPngGbTZbn1n4M6huGIeizUmjysthLwU3Zxoq4/edit?usp=sharing){target="_blank" rel="noopener noreferrer"}. * All national, official and ad-hoc statistics should be [published on EES](#ees) -* Management Information should be published on [.gov.uk](#gov.uk) +* Management Information should be published on [GOV.UK](#gov.uk) * [Interactive dashboards](#dashboards) built for particular user needs can be published separately, but should have a linked publication on either EES or GOV.UK -The following table outlines the key differences between publishing via EES and the old method via [gov.uk:](https://www.gov.uk/government/organisations/department-for-education/about/statistics){target="_blank" rel="noopener noreferrer"} +The following table outlines the key differences between publishing via EES and the old method via [GOV.UK](https://www.gov.uk/government/organisations/department-for-education/about/statistics){target="_blank" rel="noopener noreferrer"} -| Statistics collections on gov.uk | Explore education statistics | +| Statistics collections on GOV.UK | Explore education statistics | |:------|:------| | Statisticians request pdf and excel files are uploaded to release pages on gov.uk | Statisticians load csv data files on to the service and use them to build release pages | | Release attachments are reviewed and approved via emails | Releases are reviewed and approved within the service | @@ -66,15 +66,15 @@ All national, official and ad-hoc statistics should be published on EES. This se ## Publication checklist -Before releasing statistics for the first time you may want to discuss the new process with key stakeholders and/or pre-release users to make them aware of the new service. You should also inform the [Explore Statistics Mailbox](mailto:explore.statistics@education.gov.uk) and [HoP Office](mailto:Hop.STATISTICS@education.gov.uk) teams. +Before releasing statistics for the first time you may want to discuss the new process with key stakeholders and / or pre-release users to make them aware of the new service. You should also inform the [explore education statistics platforms team](mailto:explore.statistics@education.gov.uk) and [Statistics HoP Office](mailto:Hop.STATISTICS@education.gov.uk). Before you start creating a release in the platform you should have: -* Announced the upcoming release via gov.uk +* Announced the upcoming release via GOV.UK * Sent metadata form to HoP * Contacted the BAU team so we can support you with your first release -* Produced your tidy csv data files with appropriate disclosure control -* Produced metadata files for each csv data file +* Produced your tidy CSV data files with appropriate disclosure control +* Produced metadata files for each CSV data file * Ran your data and metadata through our [screener checks](https://rsconnect/rsc/dfe-published-data-qa/) Before you publish a release you have created in the platform you should have: @@ -97,10 +97,10 @@ Word templates for the data guidance, pra-list, and content can be found on [sha --- -## Linking to gov.uk +## Linking to GOV.UK -You will need to arrange a gov.uk statistics publication page so that it links to EES. Here is how to do that: +You will need to arrange a GOV.UK statistics publication page so that it links to EES. Here is how to do that: Two days ahead of publication, you’ll need to [raise a ticket with the Digital communications (gov.uk) team](https://dfe.service-now.com/serviceportal?id=sc_cat_item&sys_id=1f40a44ddb50fa005ca2fddabf961922&sysparm_category=611828a6db6c2f403b929334ca9619f6&catalog_id=-1){target="_blank" rel="noopener noreferrer"} and ask them to **create a new gov.uk statistics page with a link to EES, connect it to the announcement and add to any collections.** diff --git a/statistics-production/ud.qmd b/statistics-production/ud.qmd index 0c6409d2..bc349713 100644 --- a/statistics-production/ud.qmd +++ b/statistics-production/ud.qmd @@ -50,11 +50,11 @@ This can be run on any data file, though requires an associated [EES metadata fi For data to be used with the table tool and charts in EES, it needs to meet the following overall specifications: -* The data should be contained in a [text file with comma separated values](#data-format) and with the extension .csv. +* The data should be formatted as a [comma separated values (CSV) file](#data-format). * The first row of the data file should contain [machine readable column names](#variable-names) in [snake case](https://en.wikipedia.org/wiki/Snake_case){target="_blank" rel="noopener noreferrer"}. * The data should be layed out in line with [tidy data principles](#tidy-data-structure), consisting of filters (category fields) and indicators (value fields). * The file should contain the [necessary mandatory columns](#time-and-geography) (i.e. time_period, time_identifier, geographical_level, country_code and country_name); -* The data file should have an accompanying [metadata csv file](#ees-metadata), which contains information on the nature of the columns in the data file: +* The data file should have an accompanying [metadata CSV file](#ees-metadata), which contains information on the nature of the columns in the data file: * whether a given column is a filter or indicator; * human readable name for use in tables and charts on EES; * filter grouping information; @@ -138,11 +138,7 @@ For publishing on EES specifically, please note the following points: - We expect that multiple data files may be provided for each release. - Keep in mind that a data block can only have a single data source. However, many blocks can share one source. - You should include all years of the data you available in your data file to facilitate time series analysis. -- Each data file must be accompanied by a corresponding .csv metadata file as outlined under [EES Metadata](#ees-metadata). - -
- In light of recent accessibility legislation, you should aim to include at least 3 years of data in EES where it exists. -
+- Each data file must be accompanied by a corresponding CSV metadata file as outlined under [EES metadata](#ees-metadata). --- @@ -277,10 +273,14 @@ If your current processes produce wide data that you need to switch to a tidy st These standards give you the power to format the data in a way that best meets the needs of the users. There are only a handful of formatting standards to follow to ensure best practice and consistency across all of our data.
-Data files must in comma separated values (.csv) format, and use UTF-8 encoding. You can specify this when saving the file in Excel, or exporting from elsewhere. +Data files must in comma separated values (CSV) format, and use UTF-8 encoding. You can specify this when saving the file in Excel, or exporting from elsewhere.
-If you need to use commas within a cell, then you must add a text delimiter such as quotes to your file to define each cell - this is often done automatically for you, though if you're unsure then you can open up your csv file in a text editor such as notepad to check. +If you need to use commas within a cell, then you must add a text delimiter such as quotes to your file to define each cell - this is often done automatically for you, though if you're unsure then you can open up your CSV file in a text editor such as Notepad to check. + +Comma separated values simply means that if look at the raw file, each column is separated by a comma, other forms of delimination like this also exist, such as TSV files that are 'tab' separated. Next time you have a minute, try opening up your CSV data files in Notepad, to see how they look behind the scenes! + +Saving files in CSV format should be a standard option from any analytical tool, though sometimes you need to watch out for how they are encoding special characters, for more information see the section on [how to export data with UTF8 encoding](#how-to-export-data-with-utf-8-encoding). You should also ensure that your data follows the [GSS Standards on symbols](https://gss.civilservice.gov.uk/policy-store/symbols-in-tables-definitions-and-help/){target="_blank" rel="noopener noreferrer"}, though be aware to ignore the ask that symbols are included in separate cells from the data, which is unpractical and unrealistic. @@ -363,21 +363,21 @@ Through the above guidance, we aim to develop the DfE data catalogue into a cons --- -Most of the time our data is exported as a .csv file it will have UTF-8 encoding by default. However, there are times when this isn't the case, and therefore we'll quickly run through how to check this below in each of Excel, SQL, and R. +Most of the time our data is exported as a CSV file it will have UTF-8 encoding by default. However, there are times when this isn't the case, and therefore we'll quickly run through how to check this below in each of Excel, SQL, and R. **Excel** -Excel tends to save all .csv files as UTF-8, however this is not always the case, particularly if there are symbols in the file (such as £). To ensure that it saves with UTF-8 encoding you can select the following when saving a file: +Excel tends to save all CSV files as UTF-8, however this is not always the case, particularly if there are symbols in the file (such as £). To ensure that it saves with UTF-8 encoding you can select the following when saving a file: `File > Save As > CSV UTF-8 (Comma delimited) (*.csv)` **SQL** -For saving results out of SQL as a .csv file there isn't an option to specify the encoding, therefore the best bet is to either open the file in Excel and specify that as above, or to run your SQL query/read your data into R and follow the guidance below. +For saving results out of SQL as a CSV file there isn't an option to specify the encoding, therefore the best bet is to either open the file in Excel and specify that as above, or to run your SQL query/read your data into R and follow the guidance below. **R** -When writing .csv files out of R, you'll mostly likely be using either `write.csv()` from base R, or `write_csv()` from the readr package. For the first one, you can specify encoding using `fileEncoding = ` like the following example: +When writing CSV files out of R, you'll mostly likely be using either `write.csv()` from base R, or `write_csv()` from the readr package. For the first one, you can specify encoding using `fileEncoding = ` like the following example: `write.csv(my_data, file = "my_data_file.csv", fileEncoding = "UTF-8")` @@ -415,7 +415,7 @@ We generally recommend fewer large files over a larger number of smaller files. --- -There are no character or size limits in a csv file and there is no size limit for EES, though the larger a file is, the longer it will take to upload and process. Also remember that the files you upload are the files that users will download, consider the software they may access to (e.g. Excel) and whether the size of your files are compatible with this. +There are no character or size limits in a CSV file and there is no size limit for EES, though the larger a file is, the longer it will take to upload and process. Also remember that the files you upload are the files that users will download, consider the software they may access to (e.g. Excel) and whether the size of your files are compatible with this. Excel has a cell character limit of 32,760 and a row limit of 1,048,576. It is best to avoid exceeding these as some end users may struggle to open the file. One good way to cut the file down is to split after a certain number of years, or to separate out different geographic levels into separate files, providing school level data as a separate file for example. With the data all being in a tidy format these are then easy enough for secondary analysts to stitch back together if needed. @@ -452,7 +452,7 @@ If you have any other conventions you've used in previous publications, or a sce ## EES metadata -Metadata in a machine readable (.csv) format must accompany datasets uploaded to the explore education statistics service to ensure that the files can be processed correctly. This data will not be seen by users and is purely for EES to be able to understand and read your data. +Metadata in a machine readable (CSV) format must accompany datasets uploaded to the explore education statistics service to ensure that the files can be processed correctly. This data will not be seen by users and is purely for EES to be able to understand and read your data. This EES metadata is different to any metadata files you may provide alongside your data for your users. @@ -798,11 +798,9 @@ This approach will work for basic filtering of providers and schools but it may --- -
+#### Geography summary -

Remember

- -
+--- - You must have the minimum expected geography columns, country_code and country_name. - You must also have the additional columns required for all geographies included in your file. @@ -812,8 +810,6 @@ This approach will work for basic filtering of providers and schools but it may - Aside from blanks, no two geographic locations should have the same code. - You can mix geographies in the same file, and should avoid separating files by geography unless size is an issue. -
- --- ## Common harmonised variables @@ -1279,7 +1275,7 @@ Like filters, indicator names must not include spaces, and ideally be formatted In EES, the platform itself will format large numeric values to include commas, so you do not need to have commas for separating large numbers in your data file. -If you are including percentages and want to show 79% in EES, you would have the value 79 in your data file and specify % as the unit for that column in the EES metadata. As best practice we recommend that you include as much detail as possible in your underlying files when it comes to decimal places. As a default EES will round decimals to 2 d.p. in the platform, though if you would prefer to display your data to a different number of d.p. in the platform please use the [indicator_dp](#ees-metadata) column to specify this in the .csv metadata. Likewise with financial data, for don't include £ in the values in the data file, leave those cells as numeric only, include it as an indicator unit instead. +If you are including percentages and want to show 79% in EES, you would have the value 79 in your data file and specify % as the unit for that column in the EES metadata. As best practice we recommend that you include as much detail as possible in your underlying files when it comes to decimal places. As a default EES will round decimals to 2 d.p. in the platform, though if you would prefer to display your data to a different number of d.p. in the platform please use the [indicator_dp](#ees-metadata) column to specify this in the CSV metadata. Likewise with financial data, for don't include £ in the values in the data file, leave those cells as numeric only, include it as an indicator unit instead. In line with GSS best practice for communicating uncertainty, when using confidence intervals you should report the upper and lower bounds as separate columns rather than as one confidence interval column: @@ -1344,13 +1340,13 @@ Each publication team should regularly review the indicator and filter field nam The recommended process for this is to follow these steps: -* collate all col_name, col_type, label, indicator_grouping and filter_grouping_column fields from meta data files into one single csv file; +* collate all col_name, col_type, label, indicator_grouping and filter_grouping_column fields from meta data files into one single CSV file; * check for indicators that contain information better suited to filter entries (in line with tidy data principles); * check indicator and filter col_name entries against published current standard names and assign new col_name entries as appropriate; * check indicator and filter col_name entries against standard naming conventions and assign new col_name entries as appropriate and * check indicator and filter col_name entries for internal consistency and assign new col_name entries as appropriate. -Please collate the above into a csv file similar to your publication meta csv files. This should have the following columns: +Please collate the above into a CSV file similar to your publication meta CSV files. This should have the following columns: * col_name * col_type @@ -1380,7 +1376,7 @@ Your team should then keep a copy as a log of any changes and also send a copy t A further step teams can take to maintain standardization is to review the filter options or entries within their filters. For example, any ethnicity fields should conform to our published harmonized (GSS) ethnicity guidance. -As with field names we recommend collating these into a master csv file covering your entire publication. Expected entries are: +As with field names we recommend collating these into a master CSV file covering your entire publication. Expected entries are: * col_name * filter_grouping_column diff --git a/writing-visualising/dashboards.qmd b/writing-visualising/dashboards.qmd index 18f44263..025a196c 100644 --- a/writing-visualising/dashboards.qmd +++ b/writing-visualising/dashboards.qmd @@ -18,7 +18,7 @@ This guidance is aimed primarily at dashboards published to supplement Official This page includes specific guidance for R Shiny dashboards, for teams using PowerBI, the department has a set of PowerBI dashboard standards that can be found on the [DfE's analytical services GitHub area](https://dfe-analytical-services.github.io/powerbi_dashboardstandards/). -There is also a dashboards version of the content design checklist. This checklist runs through a number of things to think about when developing dashboards to compliment official statistics and is worth using to design and also review any dashboards you own - [Dashboards checklist (.xlsx)](../resources/Content_Design_Logbook_Dashboards.xlsx). We also have a [dashboard procedure checklist](#dashboard-procedure-checklist) in this guidance page that outlines the steps required to set up an R shiny dashboard. +There is also a dashboards version of the content design checklist. This checklist runs through a number of things to think about when developing dashboards to compliment official statistics and is worth using to design and also review any dashboards you own - [Dashboards checklist (.xlsx)](../resources/Content_Design_Logbook_Dashboards.xlsx). We also have a [dashboard procedure checklist](#dashboard-procedure-checklist) in this guidance page that outlines the steps required to set up an R Shiny dashboard. --- @@ -147,7 +147,7 @@ Google Analytics is a free service that collects information on who visits your In line with [recent legislation](https://www.gov.uk/guidance/accessibility-requirements-for-public-sector-websites-and-apps) for public sector websites, all dashboards need to meet the latest [Web Content Accessibility Guidance](https://www.w3.org/TR/WCAG21/). -As a minimum we expect all dashboards to be checked using Lighthouse and have an accessibility statement before being published. In addtion, R-Shiny dashboards should be tested with shinya11y. +As a minimum we expect all dashboards to be checked using Lighthouse and have an accessibility statement before being published. In addtion, R Shiny dashboards should be tested with shinya11y. Your statement should be written in line with the [accessibility statement guidance](https://www.gov.uk/guidance/make-your-website-or-app-accessible-and-publish-an-accessibility-statement#publish-your-accessibility-statement), and you can make use of a [template accessibility statement](https://www.gov.uk/government/publications/sample-accessibility-statement/sample-accessibility-statement-for-a-fictional-public-sector-website) provided by .gov.uk.