Skip to content

Commit

Permalink
EES page tidy up (#100)
Browse files Browse the repository at this point in the history 
* 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?
  • Loading branch information
@cjrace
cjrace authored Sep 18, 2024
1 parent 95f1f71 commit 0064e0a
Show file tree
Hide file tree
Showing 6 changed files with 237 additions and 196 deletions.
6 changes: 3 additions & 3 deletions index.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
313 changes: 177 additions & 136 deletions statistics-production/ees.qmd
View file

Large diffs are not rendered by default.

40 changes: 22 additions & 18 deletions statistics-production/embedded-charts.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
title: "Embedded visualisations in EES"
---

<p class="text-muted">Guidance for creating and embedding R-Shiny visualisations in EES publications</p>
<p class="text-muted">Guidance for creating and embedding R Shiny visualisations in EES publications</p>

---

# 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).**

Expand All @@ -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.

Expand All @@ -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:

Expand All @@ -67,17 +68,19 @@ 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.

To get an app set-up for use with EES, you'll need the [explore education statistics platforms](mailto:explore.statistics@education.gov.uk) team to create a repo for the app within the [DfE Analytical Services area on GitHub](https://github.com/dfe-analytical-services/dfe-tiny-shiny).

---

## 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:

Expand All @@ -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);
Expand All @@ -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:

Expand Down
24 changes: 12 additions & 12 deletions statistics-production/pub.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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:
Expand All @@ -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.**

Expand Down
Loading

0 comments on commit 0064e0a

Please sign in to comment.