Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

50 normalise book #220

Merged
merged 40 commits into from
Mar 10, 2025
Merged
Changes from 1 commit
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
2a8685b
added oxford commas for consistency
beth-e-jones Oct 21, 2024
d83f87c
punctuation and typo changes
beth-e-jones Oct 21, 2024
e2015a2
minor punctuation edits on Principles
beth-e-jones Oct 23, 2024
fd20a7d
punctuation and grammatical edits
beth-e-jones Oct 23, 2024
a7730df
punctuation consistency in Readable Code
beth-e-jones Oct 23, 2024
27f0d8e
consistency edits for Structure chapter
beth-e-jones Oct 23, 2024
276f42d
minor edits on code documentation chapter
beth-e-jones Oct 24, 2024
680e77f
punctuation edits as far as Vignettes in project_docs
beth-e-jones Oct 24, 2024
8a56c84
edits for continuity in punctuation
beth-e-jones Oct 24, 2024
ebb8bf4
minor edits for punctuation and style consistency
beth-e-jones Oct 24, 2024
b61174b
consistency in formatting for data chapter
beth-e-jones Oct 24, 2024
8184c8e
removed duplicated paragrapjs
beth-e-jones Oct 24, 2024
3f3919d
consistency in style and punctuation for CI chapter
beth-e-jones Oct 24, 2024
4b1eb79
Merge branch 'main' of https://github.com/best-practice-and-impact/qa…
beth-e-jones Oct 29, 2024
6299459
reduced passive sentences in introduction
beth-e-jones Oct 29, 2024
3fdd502
removed several passive sentences in glossary
beth-e-jones Oct 29, 2024
4fb416d
removed passive sentences in managers guide
beth-e-jones Oct 29, 2024
7c9a4bb
removed passive sentences in Principles chapter
beth-e-jones Oct 30, 2024
00fd4a1
reduced passive sentences in Modular code chapter
beth-e-jones Oct 30, 2024
a152fcc
reduced passive sentences in Readable Code
beth-e-jones Oct 30, 2024
5495130
edited passive sentences in modular code section
beth-e-jones Oct 30, 2024
fddbd6d
reduced passive sentences in Project Structure chapter
beth-e-jones Oct 31, 2024
09fa804
reduced passive sentences in Documenting Code
beth-e-jones Oct 31, 2024
cd49e18
reduced passive sentences in project documentation section
beth-e-jones Oct 31, 2024
203cfba
reduced passive sentences in Documenting Projects section
beth-e-jones Oct 31, 2024
c831519
editing passive sentences in version control section
beth-e-jones Oct 31, 2024
1215d1e
editing passive sentences in version control (done to line 600)
beth-e-jones Oct 31, 2024
227b773
reduced passive sentences in version control
beth-e-jones Nov 4, 2024
442f339
reduced passive sentences in configuration section
beth-e-jones Nov 4, 2024
7df59bc
reduced passive sentences in data management section
beth-e-jones Nov 4, 2024
5e156ee
reduced passive sentences in peer review chapter
beth-e-jones Nov 4, 2024
c6985b3
edited passive voice and simplified some parts in automating qa chapter
ellie-o Nov 20, 2024
a1f04b2
Merging branch to pick up testing chapter edits so book can be normal…
ellie-o Jan 13, 2025
71ec243
Reduced passive voice in testing chapter. Some grammar edits and simp…
ellie-o Jan 15, 2025
4c055fe
converted some passive sentences to active in testing chapter
beth-e-jones Jan 20, 2025
0879cac
fix broken internal link in version control chapter
sarahcollyer Feb 20, 2025
d37b251
remove reference to broken link
sarahcollyer Feb 20, 2025
1cd0ebb
Proof read all chapters Martin R
zarbspace Feb 27, 2025
526f34d
Fix comments highlighted in review
sarahcollyer Mar 10, 2025
0ceb1a7
Update config to work with auto generated header anchors (#221)
sarahcollyer Mar 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
removed passive sentences in Principles chapter
beth-e-jones committed Oct 30, 2024
commit 7c9a4bb3a2e578453ec8d3146fefab6e0aaff941
21 changes: 10 additions & 11 deletions book/principles.md
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ Assurance improves the average quality and includes the communication of that qu
```{admonition} Key strategies
:class: admonition-strategies

Government guidance is available to help you when developing analysis.
Government guidance is available to help you when develop analysis.
We recommend:

1. The [Analysis Function reproducible analytical pipelines (RAP) strategy](https://analysisfunction.civilservice.gov.uk/policy-store/reproducible-analytical-pipelines-strategy/),
@@ -50,19 +50,18 @@ If you can't prove that you can run the same analysis, with the same data, and o
The additional assurances of peer review, rigorous testing,
and validity are secondary to being able to reproduce any analysis that you carry out in a proportionate amount of time.

Reproducible analysis relies on a transparent production process, so that anyone can follow your steps and understand your results.
A reproducible and transparent production process ensures that anyone can follow your steps and understand your results.
This transparency eases reuse of your methods and results.
Easy reproducibility helps your colleagues test and validate what you have done.
When reproducibility is guaranteed,
users and colleagues can focus on verifying that the implementation is correct and that the research is useful for its intended purpose.
Guaranteeing reproducibility means that users and colleagues can focus on verifying that the implementation is correct and that the research is useful for its intended purpose.

Reproducibility relies on effective documentation.
Good documentation should show how your methodology and your implementation map to each other.
Good documentation should allow users and other researchers to reuse and adapt your analysis.

Reproducible analysis supports the requirements of the [Code of Practice for Statistics](https://www.statisticsauthority.gov.uk/code-of-practice/)
around quality assurance and transparency (auditability).
Wherever possible, we share the code we used to produce our outputs, along with enough data to allow for proper testing.
We share the code we used to produce our outputs wherever possible, along with enough data to allow for proper testing.


## Auditable
@@ -80,31 +79,31 @@ They know who is responsible for each part of the analysis, including the assura
They know exactly what changes have been made at any point.

In a reproducible workflow, you must bring together the code and the data that you used to generate your results.
These are ideally published alongside your reports, with a record of analytical choices made and the responsible owners of those choices.
The transparency that this gives your work helps to increase trustworthiness.
Ideally, you would publish these alongside your reports, with a record of analytical choices made and the responsible owners of those choices.
This increases the trustworthiness of your work.
More eyes examining your work can point out challenges or flaws that can help you to improve.
You can be fully open about the decisions you made when you generated your outputs, so that other analysts can follow what you did and re-create them.
By making your analysis reproducible, you make it easier for others to quality assure, assess and critique.


## Assured

Good quality analysis requires good Quality Assurance (QA).
Quality Assurance (QA) is vital for good quality analysis.
If decisions are being made based on analysis then this analysis must be held to high standards.
This is true for analysis carried out using any medium, including code.

However, some of the analysis that we do in government doesn't bear on decisions at that level.
We don't want to overburden analysts with QA procedures when they are not required.
In government we advocate **proportionality** - the right quality assurance procedures for the right analysis.
Analysis can be proportionately assured through peer review and defensive design.
You can proportionately assure analysis through peer review and defensive design.

We suggest following your department's guidance on what proportionate quality assurance looks like.
Most departments derive their guidance from the [Aqua book](https://www.gov.uk/government/publications/the-aqua-book-guidance-on-producing-quality-analysis-for-government).
Assurance is best demonstrated through peer review.
Peer reviewers must be able to understand your analytical choices and be able to reproduce your conclusions.
Dual running should be considered, particularly for high risk analysis.
Consider dual running, particularly for high risk analysis.

Guarantees of quality assurance should be published alongside any report, or be taken into consideration by decision makers.
Publish guarantees of quality assurance alongside any report, to be taken into consideration by decision makers.


## Reproducible analytical pipelines