best-practice-and-impact / ONS_minimum_RAP

Draft RAP minimum standard guidance for ONS

Minimum Reproducible Analytical Pipelines (RAP) standards for the Office for National Statistics (ONS)

This repository contains draft minimum standards for building Reproducible Analytical Pipelines at the ONS. The standards are not currently finalised, so this guidance is not official ONS policy yet. The site is published as an alpha version to get feedback. The contents of this repository should only be used for feedback purposes.

Building the site

Make sure you have quarto installed and working before you start.

We have used RStudio and R to build the site. To follow the same approach, make sure you have R and RStudio installed. Install the quarto package and associated dependencies for R.

Open the R project ONS_minimum_RAP.Rproj in RStudio.

Run the following command:

quarto::quarto_render("site")

Alternatively, if you do not have the repository location as your working directory, run the following command:

quarto::quarto_render("path_to_repository/site")

Editing the site

All site contents can be found in the site/ folder. When adding or removing pages, or changing filenames, remember to edit the _quarto.yml file under the website settings, e.g.:

website:
  title: ONS minimum RAP standards
  navbar:
    left:
      - href: index.qmd
        text: Home
      - href: page_1.qmd
        text: Page 1
      - href: page_2.qmd
        text: Page 2