Skip to content

Commit

Permalink
shuffling pages
Browse files Browse the repository at this point in the history
  • Loading branch information
cjrace committed Sep 30, 2023
1 parent e8566e3 commit c7f39d4
Show file tree
Hide file tree
Showing 13 changed files with 137 additions and 110 deletions.
45 changes: 13 additions & 32 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@ project:
type: website

website:
# reader-mode: true
page-navigation: true
back-to-top-navigation: true
title: "Statistician's Guide"
site-url: "https://dfe-analytical-services.github.io/statisticians-guide/"
repo-url: https://github.com/dfe-analytical-services/statisticians-guide
title: "Analyst's Guide"
site-url: "https://dfe-analytical-services.github.io/analysts-guide"
repo-url: https://github.com/dfe-analytical-services/analysts-guide
repo-actions: [edit, issue]
google-analytics: "G-KBJCBD114T"
cookie-consent:
Expand All @@ -21,24 +20,6 @@ website:
search:
location: navbar
type: textbox

#### -- Starting attempt at navbar alternative --
# navbar:
# background: primary
# search: true
# left:
# - text: "Homepage"
# file: index.qmd
# - text: "Learning resources"
# menu:
# - text: "General resources"
# file: learning-development.qmd
# - text: "SQL"
# file: sql.qmd
# - text: "R"
# file: r.qmd
# - text: "Git"
# file: git.qmd

sidebar:
logo: "images/duck_guidance.png"
Expand Down Expand Up @@ -82,10 +63,10 @@ website:

- icon: github
menu:
- href: https://github.com/dfe-analytical-services/statisticians-guide
- href: https://github.com/dfe-analytical-services/analysts-guide
target: _blank
text: "Source code"
- href: https://github.com/dfe-analytical-services/statisticians-guide/issues/new
- href: https://github.com/dfe-analytical-services/analysts-guide/issues/new
target: _blank
text: "Suggest changes"

Expand All @@ -101,27 +82,27 @@ website:
- learning-development/sql.qmd
- learning-development/r.qmd
- learning-development/git.qmd
- section: "Creating statistics"
contents:
- creating-statistics/ud.qmd
- creating-statistics/cd.qmd
- section: "Publishing statistics"
- section: "Statistics production"
contents:
- publishing-statistics/pub.qmd
- publishing-statistics/dashboards.qmd
- creating-statistics/ud.qmd
- publishing-statistics/ees.qmd
- publishing-statistics/embedded-charts.qmd
- publishing-statistics/examples.qmd
- section: "Understanding users"
contents:
- understanding-users/user-eng.qmd
- understanding-users/user-analytics.qmd
- section: "Writing and visualising"
contents:
- creating-statistics/cd.qmd
- publishing-statistics/dashboards.qmd
- section: "Reproducible Analytical Pipelines (RAP)"
contents:
- RAP/rap-expectations.qmd
- RAP/rap-support.qmd
- RAP/rap-faq.qmd
- RAP/rap-statistics.qmd
- section: "ADA and databricks"
contents:

format:
html:
Expand Down
113 changes: 35 additions & 78 deletions index.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Statistician's Guide"
title: "Analysts's Guide"
date: "Last updated: `r Sys.Date()`"
author: "statistics.development@education.gov.uk"
site: "_site.yml"
Expand All @@ -12,13 +12,9 @@ library(fontawesome)

---

This website is a guide aimed at anyone working in analysis or statistics in the Department for Education (DfE). It details best practice and learning resources across a number of areas listed out on this page.
This website is a guide aimed at anyone working in analysis or statistics in the Department for Education (DfE). It includes tips on best practice and learning resources across a number of areas.

If viewed in its entirety, it provides a walk-through guide for statisticians from processing to publication, as well as being a single reference point that is easy to navigate if you just need to check on a specific part of the process, link off to other resources, or access specific guidance.

There is already a wealth of resources out there, and therefore this site unashamedly aims to pool the relevant resources into one place. There are some things that this site does not yet have, it will develop and change over time.

We hope it can prove a useful resource for everyone from the most experienced right through to those just starting out. If you have any feedback, suggested additions, or wish to challenge any of the guidance, please contact us using the envelope button in the top right corner.
We hope it can prove a useful community driven resource for everyone from the most experienced analyst right through to those just starting out. If you have any feedback, suggested additions, or wish to challenge any of the guidance, feel free to use the GitHub links to suggest changes directly, or contact us at the email you can find at the bottom of the page.


## Learning and development
Expand All @@ -30,44 +26,52 @@ We hope it can prove a useful resource for everyone from the most experienced ri
- Guidance and tips for accessing data via databases with SQL

[R](learning-development/r.html)
- Guidance and tips for using the programming language R
- Guidance and tips for using R

[Git](learning-development/git.html)
- Guidance and tips for version control with Git

## Creating statistics

[Open data standards](creating-statistics/ud.html)
- Guidance on how to structure data files
[Python](learning-development/python.html)
- Guidance and tips for using Python [NEW PAGE]

[Writing and visualising](creating-statistics/cd.html)
- Things to consider when writing statistical commentary

## Publishing statistics
## Statistics production

[How to publish](publishing-statistics/pub.html)
[How to publish](statistics-production/pub.html)
- Guidance for how to publish different types of statistics

[Public dashboards](publishing-statistics/dashboards.html)
- Guidance for publishing official statistics dashboards
[Open data standards](statistics-production/ud.html)
- Guidance on how to structure data files

[Publication pipelines](statistics-production/stats_rap_redirect.html)
- Link to the RAP for stats? [NEW PAGE / REDIRECT]

[Using EES](publishing-statistics/ees.html)
[Using EES](statistics-production/ees.html)
- How to use the features in Explore Education Statistics

[Good examples in EES](publishing-statistics/examples.html)
- Examples of good practice in Explore Eduaction Statistics
[Good examples in EES](statistics-production/examples.html)
- Examples of good practice in Explore Education Statistics

[Embedded visualisations in EES](publishing-statistics/embedded-charts.html)
[Embedded visualisations in EES](statistics-production/embedded-charts.html)
- How to embed R-Shiny charts in EES publications

## Understanding users

[User engagement](understanding-users/user-eng.html)
[User engagement](statistics-production/user-eng.html)
- Guidance on understanding and engaging with the users of published statistics

[EES analytics](understanding-users/user_analytics.html)
[EES analytics](statistics-production/user_analytics.html)
- Understanding how users are interacting with your publications

## Writing and visualising data

[Public dashboards](writing-visualising/dashboards.html)
- Guidance for publishing public facing statistics dashboards

[Writing about statistics](writing-visualising/cd.html)
- Things to consider when writing about statistics and data

[Visualising data](writing-visualising/visualising.html)
- Resources and best practice to guide you when visualising data [NEW PAGE]

## Reproducible Analytical Pipelines (RAP)

[RAP expectations](RAP/rap-expectations.html)
Expand All @@ -82,61 +86,14 @@ We hope it can prove a useful resource for everyone from the most experienced ri
[RAP in statistics](RAP/rap-statistics.html)
- Detailed RAP guidance for statistics publications

## Our resources



We also have a number of other applications for statistics production teams to use to help them in their processes, they can be accessed at the links below when using a DfE device.



### EES data screening app



This application allows you to screen your data files against the underlying data standards for Official and National statistical publications. If your file passes the checks it also gives you some basic options for exploring the data in the file.

- [EES data screener](https://rsconnect/rsc/dfe-published-data-qa/){target="_blank" rel="noopener noreferrer"}

- [Data screener code on GitHub](https://github.com/dfe-analytical-services/dfe-published-data-qa){target="_blank" rel="noopener noreferrer"}



### EES analytics



There is an R Shiny dashboard that provides access to the Google Analytics data for the Explore Education Statistics platform.

- [Explore Education Statistics analytics dashboard](https://rsconnect/rsc/ees-analytics/){target="_blank" rel="noopener noreferrer"}

- Code is not yet publicly available, it is stored in Azure DevOps, contact us if you are interested in seeing it or contributing.



### Publication RAP self-assessment tool



A self assessment tool allowing official statistics publications to understand how their production processes match up against RAP expectations.

- [RAP self-assessment tool](https://rsconnect/rsc/publication-self-assessment/){target="_blank" rel="noopener noreferrer"}

- [RAP self-assessment code mirrored on GitHub](https://github.com/dfe-analytical-services/publication-self-assessment-copy){target="_blank" rel="noopener noreferrer"}



### Template code

- [Template DfE R Shiny dashboard](https://github.com/dfe-analytical-services/shiny-template){target="_blank" rel="noopener noreferrer"}

- [Template QA code repository](https://github.com/dfe-analytical-services/automated-data-qa){target="_blank" rel="noopener noreferrer"}
## ADA and databricks

- [dfeR R package](https://github.com/dfe-analytical-services/dfeR){target="_blank" rel="noopener noreferrer"}
[Something]()
- ? TBC

## Our mailbox
## Contact us

Our mailbox is always monitored and is available for anyone in DfE to ask questions about analysis, whether that is about RAP, building dashboards, coding support, learning and development or statistics publications.
Our mailbox is always monitored and is available for anyone in DfE to ask questions about statistics, whether that is about RAP, building dashboards, coding support, learning and development or statistics publications.

- [statistics.development@education.gov.uk](mailto:statistics.development@education.gov.uk)
- 9am-5pm, Monday-Friday, aim to reply within 1-2 days
33 changes: 33 additions & 0 deletions learning-development/python.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "Python"
---

<p class="text-muted">Guidance and tips for using Python</p>

---

## What is Python


It is a version control software. It is by far the best of its kind and is widely used by software developers and data scientists.

---

## What is Python for

Python is a high-level, general-purpose programming language that is designed to be easily readible.

---

## How to install Python



---

## Best places to start

The Python Software Foundation provides an [introduction for beginners to Python](https://www.python.org/about/gettingstarted/).

We recommend making use of the following communities:
- Python DfE community on teams
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
56 changes: 56 additions & 0 deletions statistics-production/stats_tools.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: "Tools for statistics"
---

<p class="text-muted">Guidance for how to use the tools available for statistics publishers</p>

---


We also have a number of tools for statistics production teams to use to help them in their processes, they can be accessed at the links below when using a DfE device.



### EES data screening app



This application allows you to screen your data files against the underlying data standards for Official and National statistical publications. If your file passes the checks it also gives you some basic options for exploring the data in the file.

- [EES data screener](https://rsconnect/rsc/dfe-published-data-qa/){target="_blank" rel="noopener noreferrer"}

- [Data screener code on GitHub](https://github.com/dfe-analytical-services/dfe-published-data-qa){target="_blank" rel="noopener noreferrer"}



### EES analytics



There is an R Shiny dashboard that provides access to the Google Analytics data for the Explore Education Statistics platform.

- [Explore Education Statistics analytics dashboard](https://rsconnect/rsc/ees-analytics/){target="_blank" rel="noopener noreferrer"}

- Code is not yet publicly available, it is stored in Azure DevOps, contact us if you are interested in seeing it or contributing.



### Publication RAP self-assessment tool



A self assessment tool allowing official statistics publications to understand how their production processes match up against RAP expectations.

- [RAP self-assessment tool](https://rsconnect/rsc/publication-self-assessment/){target="_blank" rel="noopener noreferrer"}

- [RAP self-assessment code mirrored on GitHub](https://github.com/dfe-analytical-services/publication-self-assessment-copy){target="_blank" rel="noopener noreferrer"}



### Template code

- [Template DfE R Shiny dashboard](https://github.com/dfe-analytical-services/shiny-template){target="_blank" rel="noopener noreferrer"}

- [Template QA code repository](https://github.com/dfe-analytical-services/automated-data-qa){target="_blank" rel="noopener noreferrer"}

- [dfeR R package](https://github.com/dfe-analytical-services/dfeR){target="_blank" rel="noopener noreferrer"}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit c7f39d4

Please sign in to comment.