Skip to content

Commit

Permalink
Merge pull request #235 from best-practice-and-impact/fix_99_coding_b…
Browse files Browse the repository at this point in the history
…est_practice

Fix 99 coding best practice
  • Loading branch information
irisoren-sg authored Oct 8, 2024
2 parents 69f13fe + 34f319f commit 939d3fc
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions analysis.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ The analysis stage is where planned analysis is undertaken and assured, and prog

* The Analyst shall follow the conduct the verification and validation activities that were designed as part of the analytical plan in [the design stage](design.html#the-design-stage). They shall provide traceable documentation of the assurance they have undertaken. They shall respond to recommendations from the Assurer and act on them as appropriate.

* When the analysis includes coding, the Analyst shall proportionately follow [best practice for code development](#assurance-of-code).

* The Analyst shall produce documentation of the data and methods used. The Analyst shall ensure these are sufficient for the Assurer to understand the approach.

* The Analyst shall document any changes to the analytical plan in a proportionate manner.
Expand All @@ -34,9 +36,11 @@ The analysis stage is where planned analysis is undertaken and assured, and prog

### The Assurer's responsibilities during the analysis stage

The Assurer shall review the assurance completed by the Analyst, carry out any further validation and verification they may see as appropriate, and report errors and areas for improvement to the Analyst. The Assurer may then need to re-review the analytical work completed, as required.
* The Assurer shall review the assurance completed by the Analyst, carry out any further validation and verification they may see as appropriate, and report errors and areas for improvement to the Analyst. The Assurer may then need to re-review the analytical work completed, as required.

* When the analysis includes coding, the Assurer shall review that the work proportionately adheres to [coding best practice](#assurance-of-code).

The Assurer may be required to provide feedback on changes to the analytical plan, and consider whether they are qualified to provide rigorous assurance on the revised methodology.
* The Assurer may be required to provide feedback on changes to the analytical plan, and consider whether they are qualified to provide rigorous assurance on the revised methodology.


### The Approver's responsibilities during the analysis stage
Expand Down Expand Up @@ -82,7 +86,7 @@ The impact of using a proxy dataset should be explored and, if the uncertainty a

### Assurance of code

The [Duck Book](https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html) provides detailed guidance on developing and assurance for delivering quality code. This includes guidance on structuring code, producing documentation, using version control, data management, testing, peer review, and automation.
The [Duck Book](https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html) provides detailed guidance on developing and assurance for delivering quality code. This includes guidance on structuring code, producing documentation, using version control, data management, testing, peer review, and automation. The Analysit shall follow the guidance for good quality code development in a proportionate manner, and the Assurer shall review this accordingly.


## Documention in the analysis stage
Expand Down

0 comments on commit 939d3fc

Please sign in to comment.