Analysts' Guide

Introduction

A quarto-based static website used as a central place to hold guidance, helpful links and code examples for analysts working in DfE. The source repository is hosted in GitHub and deployed via GitHub pages.

---

Hosted environments

The guidance website is deployed to https://dfe-analytical-services.github.io/analysts-guide/.

---

Requirements

i. Software requirements

• See getting started with Quarto

ii. Programming skills required

• Basic knowledge of Quarto and markdown

• Understanding of Quarto websites

iii. Access

• A number of internal DfE videos are embedded, unless you have specific access via DfE kit they will not appear. If you are interested in their content please get in touch with us.

---

How to use

Each page of the site is a single quarto document, with index.qmd as the homepage. When the project is opened locally in RStudio you will be able to preview the whole website using one of the following options:

1. (In R Studio) clicking 'build site' in the build pane

2. Run quarto preview in the terminal, adding --render all at the end if you want to pre-render the whole site like the R Studio option does (slower initially, but faster to navigate through multiple pages)

3. Using quarto::quarto_preview() if in an R console with the quarto R package installed, render = "All" gives the equivalent behaviour to --render all in the terminal

Tests

There are currently no automated tests on this project.

Diagrams

RAP Hexagons - https://app.diagrams.net/#G1usTSACWv_gRBgibnKRK52ksOksF303Dv

RAP Badges - https://app.diagrams.net/#G1uSCknFwmzhy-YHZTGmkuqoMM_zDH2yC0

Create release - https://app.diagrams.net/#G1NcVNEtMtNO--2NtV6RPxceiRv3fDGQ7y

PRA - https://app.diagrams.net/#G1x1VLZghqCCnmDWHqgjpdU6fSSehms4FL

ADA diagram - https://app.diagrams.net/?libs=general;flowchart#G1oL9XauLLcVVbF5O_qzZhtcqQbPW9myJk

The diagrams are amended on the links above. Once you have finished amending a diagram, go to file > Embed > HTML. Leave the option of 'Include a copy of my diagram selected', change the boarder colour to none and untick the rest of the options. Press create and copy and paste the HTML code over the top of the existing code in the .qmd file.

Contribution

Pages from this guide have different code owners, their review will automatically be sought on any contributions you make. For full details of the codeowners in this repo, see the .github/CODEOWNERS file.

If you're interested in contributing to this project, have a read of the contributing guidelines.

---

Past versions

---

For ease of record keeping and slight nostalgia, past iterations of the site prior to the move to this repo in October 2023 have been listed below:

• July 2023, Statisticians Guide, Quarto site used until name change, available on GitHub

• April 2023, Quarto prototype

• Feb 2023, Ruby prototype

• March 2021, Stats Production Guidance - RMarkdown website, public facing clone on GitHub

• March 2020, Stats Production Guidance - RMarkdown website, code available on Azure DevOps - internal to DfE

• March 2020, RAP bookdown site, code available on Azure DevOps - internal to DfE

• Before this it was a bunch of loose Word documents.

---

Contact

statistics.development@education.gov.uk.