bpi-courses / introduction-to-rap

Introduction to Reproducible Analytical Pipelines (RAP) elearning course

0 stars 0 forks source link

Edits (minor) #8

Open jonathonmellor opened 2 years ago

jonathonmellor commented 2 years ago

The Practices

within "The RAP Minimum Viable Product", the first bullet point says "Augment extant technical and quality assurance...", could "existing" be used instead of "extant", I had to google what it meant, but that may just be me. Thinking about accessibility of language.
In RAP MVP, some hyper links are bolded, some are not
Useful to link the Duckbook in line where first referenced.

The Project

Pedantic but should "“As a , I , .”" be "As a , I want to , so that " or similar.

zarbspace commented 2 years ago

Replace references to Best Practice and Impact with "the Analysis Function"? #8

zarbspace commented 2 years ago

In the reveal for the "As of July 2021, approximately how many statistical publications were on the gov.uk website, "26000" should have a comma after the 26. I know it's pedantic, but it's specifically mentioned in our style guides. #8

zarbspace commented 2 years ago

The Practices

Example - 2020 exam results. There is a quoted passage in para 1, but no source for the quote.

Example - West Coast Main Line franchise. Sir Nicholas Macpherson wrote the Macpherson review. The AQUA book was developed subsequently, and was not authored by NM (although he did write the foreword).

Suggest adding a link to the Macpherson review page into the resources at the end of the section.

zarbspace commented 2 years ago

Principles of RAP

All headers should be in sentence case (Minimise manual steps)

Minimise Manual Steps

"We can cut out this intermediate step by creating our analysis using a programming language, rather than spreadsheets". Consider making more generic by replacing "spreadsheets" to include a wider range of GUI-driven tools? I'm thinking the point and click interfaces to SPSS, STATA etc. as well as Excel.

Provide a hyperlink to the GSS Quality Strategy in the body of the text? If you've decided to put these at the end every time and not hyperlink, that's fine.

Maximise transparency

Provide a link to the GDS Service Standard?

Open-source software

There is also an element of risk here, in that we are ultimately unable to verify exactly how closed source tools work, even if they are well documented.

The birth of RAP

Consider providing a reference to the GDS blog about this, or to the DCMS publication and resources?

zarbspace commented 2 years ago

The practices

RAP MVP

Update to be consistent with language of the new GSS website page covering this topic.

This section contains lots of hyperlinks, while the others restrict links to the base of the document. We should be consistent in how we use hyperlinks across the sections.