From f0e43c10b77c10f4943b3aefb4d9e1068b444074 Mon Sep 17 00:00:00 2001
From: Beth Jones
Date: Tue, 20 Feb 2024 17:04:54 +0000
Subject: [PATCH 01/32] Created intro page for template
---
.quarto/idx/faqs.qmd.json | 2 +-
.quarto/idx/feedback.qmd.json | 2 +-
.quarto/preview/lock | 2 +-
.quarto/xref/INDEX | 3 +
_quarto.yml | 2 +
apd_style.css | 1 +
assumptions_decisions_html_template.html | 922 ++++++++++
docs/assumptions_and_issues_log.html | 1487 +++-------------
docs/assumptions_decisions_html_template.html | 911 ++++++++++
docs/index.html | 1491 +++--------------
docs/sample_assumptions_log.html | 1487 +++-------------
docs/search.json | 90 +-
12 files changed, 2592 insertions(+), 3808 deletions(-)
create mode 100644 assumptions_decisions_html_template.html
create mode 100644 docs/assumptions_decisions_html_template.html
diff --git a/.quarto/idx/faqs.qmd.json b/.quarto/idx/faqs.qmd.json
index 623d73c..a50306a 100644
--- a/.quarto/idx/faqs.qmd.json
+++ b/.quarto/idx/faqs.qmd.json
@@ -1 +1 @@
-{"title":"Frequently Asked Questions","markdown":{"yaml":{"title":"Frequently Asked Questions","format":{"html":{"embed-resources":true}}},"headingText":"When should I use this guidance?","containsRefs":false,"markdown":"\n\n::: {.callout-note collapse=\"false\"}\nThis guidance is an ALPHA draft. It is in development and we are still working to ensure that it meets user needs.\n\nPlease get in touch with feedback to support the guidance by creating a [GitHub Issue](https://github.com/best-practice-and-impact/analysis_project_documentation/issues) or [emailing us](mailto:ASAP@ons.gov.uk).\n:::\n\n\nIf you are starting work on a new analysis project we recommend that you use this guidance right from the scoping stage. For teams who are in the middle of an analysis, you can still use the guidance and templates to think about the quality questions from the scoping and design stages and continue recording the answers up until the delivery stage. \n\n## Which analysis is in scope of the guidance?\n\nThe guidance applies to all analysis workflows, including analysis to support research, advice for other departments, ad-hoc and one-off outputs and regular outputs. \n\nRegular outputs often fulfil at least one of the criteria for what makes a business critical model: \n* Underpins essential financial and funding decisions; \n* Essential to the achievement of business plan actions and priorities; \n* Must be error free or else risk serious financial or legal penalties or reputational damage for the organisation. \n \nBusiness critical analysis requires the highest level of scrutiny and the governance arrangements must be appropriate for the level of risk. \n\nFor ad-hoc outputs with quick turnarounds and limited time and resources, analysis still needs sufficient quality assurance to ensure it is fit for purpose. Ad-hoc outputs are often used as part of the evidence when making important policy decisions, so getting them right is very important. \n\nWe strongly encourage senior responsible owners of both regular and ad-hoc analysis to answer all questions relevant to their role. \n\nCompleting the logs makes it much easier to understand the risks that the analysis carries and will help you plan to mitigate them. Having a proper audit trail and comprehensive logs also help when: \n* You need to explain why the analysis works as it does. \n* You need to raise quality and resourcing issues and push back against demands that are unrealistic. \n* You need to understand and communicate potential risks. \n\n## How should I identify the Senior Responsible Owner, Commissioner, Analyst and Analytical Assurer?\n\nThe [AQuA Book](https://www.gov.uk/government/publications/the-aqua-book-guidance-on-producing-quality-analysis-for-government) sets out four roles responsible for the assurance of analysis: \n* Commissioner \n* Senior Responsible Owner (SRO) (usually leads the analyst team) \n* Analysts (who usually report to the SRO) and \n* Analytical Assurer. \n\nWhat matters here is that each assurance role is covered in your workflow and that individuals know about and accept their responsibilities, not the name of the role. \n\nAs a project team, you should make sure that each role is in place and you understand how it will operate for you so that you have the right assurance. \n\nThe AQuA Book makes no expectations about levels of seniority or grade of each of the occupiers of the roles. It does not specify whether roles should be held by a person or could be held by a committee or other governance group (such as a senior leadership team). \n\nThe key consideration is whether or not the person or group that undertakes the assurance role have the skills and resources they need to meet the requirements of the role. How the roles are covered in an analysis workflow varies from project to project, depending on how the work is planned, managed and assured. \n\nWe suggest that if roles are taken by individuals, the SRO and commissioner should usually be at Grade 7 or above. If you are still unsure about how to allocate the roles among your team and governance groups, please [email us](mailto:ASAP@ons.gov.uk) with \"analysis assurance\" in the subject header and we will help you to make the decision. \n\n## What help is available to answer the quality questions?\n\nFor ONS staff, the [ONS Quality Central wiki](https://officenationalstatistics.sharepoint.com/sites/onswiki/SitePages/Quality-Central.aspx) contains lots of useful guidance, templates and mandatory training to help you work through and answer the quality questions. It includes the [ONS Quality Standard for Analysis](https://officenationalstatistics.sharepoint.com/sites/onswiki/SitePages/Quality_Standards.aspx). \n\nThese cross-government resources are also likely to be useful: \n* [Government Data Quality Hub](https://www.gov.uk/government/organisations/government-data-quality-hub) [Quality Questions and Red Flags](https://dataqualityhub.github.io/resources-for-quality-analysis-external/) and [Government Data Quality Framework](https://www.gov.uk/government/publications/the-government-data-quality-framework) \n* [Office for Statistics Regulation](https://osr.statisticsauthority.gov.uk/) [Quality Assurance of Administrative Data toolkit](https://osr.statisticsauthority.gov.uk/publication/administrative-data-quality-assurance-toolkit/) and [Quality and statistics: an OSR perspective](https://osr.statisticsauthority.gov.uk/publication/quality-and-statistics-an-osr-perspective/). \n* [The Uncertainty Toolkit for Analysts in Government](https://analystsuncertaintytoolkit.github.io/UncertaintyWeb/index.html)","srcMarkdownNoYaml":"\n\n::: {.callout-note collapse=\"false\"}\nThis guidance is an ALPHA draft. It is in development and we are still working to ensure that it meets user needs.\n\nPlease get in touch with feedback to support the guidance by creating a [GitHub Issue](https://github.com/best-practice-and-impact/analysis_project_documentation/issues) or [emailing us](mailto:ASAP@ons.gov.uk).\n:::\n\n## When should I use this guidance?\n\nIf you are starting work on a new analysis project we recommend that you use this guidance right from the scoping stage. For teams who are in the middle of an analysis, you can still use the guidance and templates to think about the quality questions from the scoping and design stages and continue recording the answers up until the delivery stage. \n\n## Which analysis is in scope of the guidance?\n\nThe guidance applies to all analysis workflows, including analysis to support research, advice for other departments, ad-hoc and one-off outputs and regular outputs. \n\nRegular outputs often fulfil at least one of the criteria for what makes a business critical model: \n* Underpins essential financial and funding decisions; \n* Essential to the achievement of business plan actions and priorities; \n* Must be error free or else risk serious financial or legal penalties or reputational damage for the organisation. \n \nBusiness critical analysis requires the highest level of scrutiny and the governance arrangements must be appropriate for the level of risk. \n\nFor ad-hoc outputs with quick turnarounds and limited time and resources, analysis still needs sufficient quality assurance to ensure it is fit for purpose. Ad-hoc outputs are often used as part of the evidence when making important policy decisions, so getting them right is very important. \n\nWe strongly encourage senior responsible owners of both regular and ad-hoc analysis to answer all questions relevant to their role. \n\nCompleting the logs makes it much easier to understand the risks that the analysis carries and will help you plan to mitigate them. Having a proper audit trail and comprehensive logs also help when: \n* You need to explain why the analysis works as it does. \n* You need to raise quality and resourcing issues and push back against demands that are unrealistic. \n* You need to understand and communicate potential risks. \n\n## How should I identify the Senior Responsible Owner, Commissioner, Analyst and Analytical Assurer?\n\nThe [AQuA Book](https://www.gov.uk/government/publications/the-aqua-book-guidance-on-producing-quality-analysis-for-government) sets out four roles responsible for the assurance of analysis: \n* Commissioner \n* Senior Responsible Owner (SRO) (usually leads the analyst team) \n* Analysts (who usually report to the SRO) and \n* Analytical Assurer. \n\nWhat matters here is that each assurance role is covered in your workflow and that individuals know about and accept their responsibilities, not the name of the role. \n\nAs a project team, you should make sure that each role is in place and you understand how it will operate for you so that you have the right assurance. \n\nThe AQuA Book makes no expectations about levels of seniority or grade of each of the occupiers of the roles. It does not specify whether roles should be held by a person or could be held by a committee or other governance group (such as a senior leadership team). \n\nThe key consideration is whether or not the person or group that undertakes the assurance role have the skills and resources they need to meet the requirements of the role. How the roles are covered in an analysis workflow varies from project to project, depending on how the work is planned, managed and assured. \n\nWe suggest that if roles are taken by individuals, the SRO and commissioner should usually be at Grade 7 or above. If you are still unsure about how to allocate the roles among your team and governance groups, please [email us](mailto:ASAP@ons.gov.uk) with \"analysis assurance\" in the subject header and we will help you to make the decision. \n\n## What help is available to answer the quality questions?\n\nFor ONS staff, the [ONS Quality Central wiki](https://officenationalstatistics.sharepoint.com/sites/onswiki/SitePages/Quality-Central.aspx) contains lots of useful guidance, templates and mandatory training to help you work through and answer the quality questions. It includes the [ONS Quality Standard for Analysis](https://officenationalstatistics.sharepoint.com/sites/onswiki/SitePages/Quality_Standards.aspx). \n\nThese cross-government resources are also likely to be useful: \n* [Government Data Quality Hub](https://www.gov.uk/government/organisations/government-data-quality-hub) [Quality Questions and Red Flags](https://dataqualityhub.github.io/resources-for-quality-analysis-external/) and [Government Data Quality Framework](https://www.gov.uk/government/publications/the-government-data-quality-framework) \n* [Office for Statistics Regulation](https://osr.statisticsauthority.gov.uk/) [Quality Assurance of Administrative Data toolkit](https://osr.statisticsauthority.gov.uk/publication/administrative-data-quality-assurance-toolkit/) and [Quality and statistics: an OSR perspective](https://osr.statisticsauthority.gov.uk/publication/quality-and-statistics-an-osr-perspective/). \n* [The Uncertainty Toolkit for Analysts in Government](https://analystsuncertaintytoolkit.github.io/UncertaintyWeb/index.html)"},"formats":{"html":{"identifier":{"display-name":"HTML","target-format":"html","base-format":"html"},"execute":{"fig-width":7,"fig-height":5,"fig-format":"retina","fig-dpi":96,"df-print":"default","error":false,"eval":true,"cache":null,"freeze":false,"echo":true,"output":true,"warning":true,"include":true,"keep-md":false,"keep-ipynb":false,"ipynb":null,"enabled":null,"daemon":null,"daemon-restart":false,"debug":false,"ipynb-filters":[],"ipynb-shell-interactivity":null,"plotly-connected":true,"engine":"markdown"},"render":{"keep-tex":false,"keep-typ":false,"keep-source":false,"keep-hidden":false,"prefer-html":false,"output-divs":true,"output-ext":"html","fig-align":"default","fig-pos":null,"fig-env":null,"code-fold":"none","code-overflow":"scroll","code-link":false,"code-line-numbers":false,"code-tools":false,"tbl-colwidths":"auto","merge-includes":true,"inline-includes":false,"preserve-yaml":false,"latex-auto-mk":true,"latex-auto-install":true,"latex-clean":true,"latex-min-runs":1,"latex-max-runs":10,"latex-makeindex":"makeindex","latex-makeindex-opts":[],"latex-tlmgr-opts":[],"latex-input-paths":[],"latex-output-dir":null,"link-external-icon":false,"link-external-newwindow":false,"self-contained-math":false,"format-resources":[],"notebook-links":true},"pandoc":{"standalone":true,"wrap":"none","default-image-extension":"png","to":"html","toc":true,"embed-resources":true,"output-file":"faqs.html"},"language":{"toc-title-document":"Table of contents","toc-title-website":"On this page","related-formats-title":"Other Formats","related-notebooks-title":"Notebooks","source-notebooks-prefix":"Source","other-links-title":"Other Links","code-links-title":"Code Links","launch-dev-container-title":"Launch Dev Container","launch-binder-title":"Launch Binder","article-notebook-label":"Article Notebook","notebook-preview-download":"Download Notebook","notebook-preview-download-src":"Download Source","notebook-preview-back":"Back to Article","manuscript-meca-bundle":"MECA Bundle","section-title-abstract":"Abstract","section-title-appendices":"Appendices","section-title-footnotes":"Footnotes","section-title-references":"References","section-title-reuse":"Reuse","section-title-copyright":"Copyright","section-title-citation":"Citation","appendix-attribution-cite-as":"For attribution, please cite this work as:","appendix-attribution-bibtex":"BibTeX citation:","title-block-author-single":"Author","title-block-author-plural":"Authors","title-block-affiliation-single":"Affiliation","title-block-affiliation-plural":"Affiliations","title-block-published":"Published","title-block-modified":"Modified","title-block-keywords":"Keywords","callout-tip-title":"Tip","callout-note-title":"Note","callout-warning-title":"Warning","callout-important-title":"Important","callout-caution-title":"Caution","code-summary":"Code","code-tools-menu-caption":"Code","code-tools-show-all-code":"Show All Code","code-tools-hide-all-code":"Hide All Code","code-tools-view-source":"View Source","code-tools-source-code":"Source Code","tools-share":"Share","tools-download":"Download","code-line":"Line","code-lines":"Lines","copy-button-tooltip":"Copy to Clipboard","copy-button-tooltip-success":"Copied!","repo-action-links-edit":"Edit this page","repo-action-links-source":"View source","repo-action-links-issue":"Report an issue","back-to-top":"Back to top","search-no-results-text":"No results","search-matching-documents-text":"matching documents","search-copy-link-title":"Copy link to search","search-hide-matches-text":"Hide additional matches","search-more-match-text":"more match in this document","search-more-matches-text":"more matches in this document","search-clear-button-title":"Clear","search-text-placeholder":"","search-detached-cancel-button-title":"Cancel","search-submit-button-title":"Submit","search-label":"Search","toggle-section":"Toggle section","toggle-sidebar":"Toggle sidebar navigation","toggle-dark-mode":"Toggle dark mode","toggle-reader-mode":"Toggle reader mode","toggle-navigation":"Toggle navigation","crossref-fig-title":"Figure","crossref-tbl-title":"Table","crossref-lst-title":"Listing","crossref-thm-title":"Theorem","crossref-lem-title":"Lemma","crossref-cor-title":"Corollary","crossref-prp-title":"Proposition","crossref-cnj-title":"Conjecture","crossref-def-title":"Definition","crossref-exm-title":"Example","crossref-exr-title":"Exercise","crossref-ch-prefix":"Chapter","crossref-apx-prefix":"Appendix","crossref-sec-prefix":"Section","crossref-eq-prefix":"Equation","crossref-lof-title":"List of Figures","crossref-lot-title":"List of Tables","crossref-lol-title":"List of Listings","environment-proof-title":"Proof","environment-remark-title":"Remark","environment-solution-title":"Solution","listing-page-order-by":"Order By","listing-page-order-by-default":"Default","listing-page-order-by-date-asc":"Oldest","listing-page-order-by-date-desc":"Newest","listing-page-order-by-number-desc":"High to Low","listing-page-order-by-number-asc":"Low to High","listing-page-field-date":"Date","listing-page-field-title":"Title","listing-page-field-description":"Description","listing-page-field-author":"Author","listing-page-field-filename":"File Name","listing-page-field-filemodified":"Modified","listing-page-field-subtitle":"Subtitle","listing-page-field-readingtime":"Reading Time","listing-page-field-wordcount":"Word Count","listing-page-field-categories":"Categories","listing-page-minutes-compact":"{0} min","listing-page-category-all":"All","listing-page-no-matches":"No matching items","listing-page-words":"{0} words"},"metadata":{"lang":"en","fig-responsive":true,"quarto-version":"1.4.549","page-layout":"full","theme":"flatly","title":"Frequently Asked Questions"},"extensions":{"book":{"multiFile":true}}}},"projectFormats":["html"]}
\ No newline at end of file
+{"title":"Frequently Asked Questions","markdown":{"yaml":{"title":"Frequently Asked Questions","format":{"html":{"embed-resources":true}}},"headingText":"When should I use this guidance?","containsRefs":false,"markdown":"\n\n::: {.callout-note collapse=\"false\"}\nThis guidance is an ALPHA draft. It is in development and we are still working to ensure that it meets user needs.\n\nPlease get in touch with feedback to support the guidance by creating a [GitHub Issue](https://github.com/best-practice-and-impact/analysis_project_documentation/issues) or [emailing us](mailto:ASAP@ons.gov.uk).\n:::\n\n\nIf you are starting work on a new analysis project we recommend that you use this guidance right from the scoping stage. For teams who are in the middle of an analysis, you can still use the guidance and templates to think about the quality questions from the scoping and design stages and continue recording the answers up until the delivery stage. \n\n## Which analysis is in scope of the guidance?\n\nThe guidance applies to all analysis workflows, including analysis to support research, advice for other departments, ad-hoc and one-off outputs and regular outputs. \n\nRegular outputs often fulfil at least one of the criteria for what makes a business critical model: \n* Underpins essential financial and funding decisions; \n* Essential to the achievement of business plan actions and priorities; \n* Must be error free or else risk serious financial or legal penalties or reputational damage for the organisation. \n \nBusiness critical analysis requires the highest level of scrutiny and the governance arrangements must be appropriate for the level of risk. \n\nFor ad-hoc outputs with quick turnarounds and limited time and resources, analysis still needs sufficient quality assurance to ensure it is fit for purpose. Ad-hoc outputs are often used as part of the evidence when making important policy decisions, so getting them right is very important. \n\nWe strongly encourage senior responsible owners of both regular and ad-hoc analysis to answer all questions relevant to their role. \n\nCompleting the logs makes it much easier to understand the risks that the analysis carries and will help you plan to mitigate them. Having a proper audit trail and comprehensive logs also help when: \n* You need to explain why the analysis works as it does. \n* You need to raise quality and resourcing issues and push back against demands that are unrealistic. \n* You need to understand and communicate potential risks. \n\n## How should I identify the Senior Responsible Owner, Commissioner, Analyst and Analytical Assurer?\n\nThe [AQuA Book](https://www.gov.uk/government/publications/the-aqua-book-guidance-on-producing-quality-analysis-for-government) sets out four roles responsible for the assurance of analysis: \n* Commissioner \n* Senior Responsible Owner (SRO) (usually leads the analyst team) \n* Analysts (who usually report to the SRO) and \n* Analytical Assurer. \n\nWhat matters here is that each assurance role is covered in your workflow and that individuals know about and accept their responsibilities, not the name of the role. \n\nAs a project team, you should make sure that each role is in place and you understand how it will operate for you so that you have the right assurance. \n\nThe AQuA Book makes no expectations about levels of seniority or grade of each of the occupiers of the roles. It does not specify whether roles should be held by a person or could be held by a committee or other governance group (such as a senior leadership team). \n\nThe key consideration is whether or not the person or group that undertakes the assurance role have the skills and resources they need to meet the requirements of the role. How the roles are covered in an analysis workflow varies from project to project, depending on how the work is planned, managed and assured. \n\nWe suggest that if roles are taken by individuals, the SRO and commissioner should usually be at Grade 7 or above. If you are still unsure about how to allocate the roles among your team and governance groups, please [email us](mailto:ASAP@ons.gov.uk) with \"analysis assurance\" in the subject header and we will help you to make the decision. \n\n## What help is available to answer the quality questions?\n\nFor ONS staff, the [ONS Quality Central wiki](https://officenationalstatistics.sharepoint.com/sites/onswiki/SitePages/Quality-Central.aspx) contains lots of useful guidance, templates and mandatory training to help you work through and answer the quality questions. It includes the [ONS Quality Standard for Analysis](https://officenationalstatistics.sharepoint.com/sites/onswiki/SitePages/Quality_Standards.aspx). \n\nThese cross-government resources are also likely to be useful: \n* [Government Data Quality Hub](https://www.gov.uk/government/organisations/government-data-quality-hub) [Quality Questions and Red Flags](https://dataqualityhub.github.io/resources-for-quality-analysis-external/) and [Government Data Quality Framework](https://www.gov.uk/government/publications/the-government-data-quality-framework) \n* [Office for Statistics Regulation](https://osr.statisticsauthority.gov.uk/) [Quality Assurance of Administrative Data toolkit](https://osr.statisticsauthority.gov.uk/publication/administrative-data-quality-assurance-toolkit/) and [Quality and statistics: an OSR perspective](https://osr.statisticsauthority.gov.uk/publication/quality-and-statistics-an-osr-perspective/). \n* [The Uncertainty Toolkit for Analysts in Government](https://analystsuncertaintytoolkit.github.io/UncertaintyWeb/index.html)"},"formats":{"html":{"execute":{"fig-width":7,"fig-height":5,"fig-format":"retina","fig-dpi":96,"df-print":"default","error":false,"eval":true,"cache":null,"freeze":false,"echo":true,"output":true,"warning":true,"include":true,"keep-md":false,"keep-ipynb":false,"ipynb":null,"enabled":null,"daemon":null,"daemon-restart":false,"debug":false,"ipynb-filters":[],"engine":"markdown"},"render":{"keep-tex":false,"keep-yaml":false,"keep-source":false,"keep-hidden":false,"prefer-html":false,"output-divs":true,"output-ext":"html","fig-align":"default","fig-pos":null,"fig-env":null,"code-fold":"none","code-overflow":"scroll","code-link":false,"code-line-numbers":false,"code-tools":false,"tbl-colwidths":"auto","merge-includes":true,"latex-auto-mk":true,"latex-auto-install":true,"latex-clean":true,"latex-max-runs":10,"latex-makeindex":"makeindex","latex-makeindex-opts":[],"latex-tlmgr-opts":[],"latex-input-paths":[],"latex-output-dir":null,"link-external-icon":false,"link-external-newwindow":false,"self-contained-math":false,"format-resources":[]},"pandoc":{"standalone":true,"wrap":"none","default-image-extension":"png","to":"html","toc":true,"embed-resources":true,"output-file":"faqs.html"},"language":{},"metadata":{"lang":"en","fig-responsive":true,"quarto-version":"1.1.163","page-layout":"full","theme":"flatly","title":"Frequently Asked Questions"},"extensions":{"book":{"multiFile":true}}}}}
\ No newline at end of file
diff --git a/.quarto/idx/feedback.qmd.json b/.quarto/idx/feedback.qmd.json
index 8d6daf2..e2eeae3 100644
--- a/.quarto/idx/feedback.qmd.json
+++ b/.quarto/idx/feedback.qmd.json
@@ -1 +1 @@
-{"title":"Feedback","markdown":{"yaml":{"title":"Feedback","format":{"html":{"embed-resources":true}}},"headingText":"Feedback","containsRefs":false,"markdown":"\n\n::: {.callout-note collapse=\"false\"}\nThis guidance is an ALPHA draft. It is in development and we are still working to ensure that it meets user needs.\n\nPlease get in touch with feedback to support the guidance by creating a [GitHub Issue](https://github.com/best-practice-and-impact/analysis_project_documentation/issues) or [emailing us](mailto:ASAP@ons.gov.uk).\n:::\n\n\nWe are keen to understand the challenges faced by analytical teams in ONS when complying with good practice. To evaluate the effectiveness of this guidance, we would be grateful if you could fill in [a short survey](https://forms.office.com/e/ya2ZzRbGHM). \n\nWe appreciate your feedback. It will help us to make additional tools and resources on good practice for producing quality analysis.\n\nIf you have questions about this guidance or the survey please email ASAP@ons.gov.uk with \"analytical QA\" in the subject header.","srcMarkdownNoYaml":"\n\n::: {.callout-note collapse=\"false\"}\nThis guidance is an ALPHA draft. It is in development and we are still working to ensure that it meets user needs.\n\nPlease get in touch with feedback to support the guidance by creating a [GitHub Issue](https://github.com/best-practice-and-impact/analysis_project_documentation/issues) or [emailing us](mailto:ASAP@ons.gov.uk).\n:::\n\n# Feedback \n\nWe are keen to understand the challenges faced by analytical teams in ONS when complying with good practice. To evaluate the effectiveness of this guidance, we would be grateful if you could fill in [a short survey](https://forms.office.com/e/ya2ZzRbGHM). \n\nWe appreciate your feedback. It will help us to make additional tools and resources on good practice for producing quality analysis.\n\nIf you have questions about this guidance or the survey please email ASAP@ons.gov.uk with \"analytical QA\" in the subject header."},"formats":{"html":{"identifier":{"display-name":"HTML","target-format":"html","base-format":"html"},"execute":{"fig-width":7,"fig-height":5,"fig-format":"retina","fig-dpi":96,"df-print":"default","error":false,"eval":true,"cache":null,"freeze":false,"echo":true,"output":true,"warning":true,"include":true,"keep-md":false,"keep-ipynb":false,"ipynb":null,"enabled":null,"daemon":null,"daemon-restart":false,"debug":false,"ipynb-filters":[],"ipynb-shell-interactivity":null,"plotly-connected":true,"engine":"markdown"},"render":{"keep-tex":false,"keep-typ":false,"keep-source":false,"keep-hidden":false,"prefer-html":false,"output-divs":true,"output-ext":"html","fig-align":"default","fig-pos":null,"fig-env":null,"code-fold":"none","code-overflow":"scroll","code-link":false,"code-line-numbers":false,"code-tools":false,"tbl-colwidths":"auto","merge-includes":true,"inline-includes":false,"preserve-yaml":false,"latex-auto-mk":true,"latex-auto-install":true,"latex-clean":true,"latex-min-runs":1,"latex-max-runs":10,"latex-makeindex":"makeindex","latex-makeindex-opts":[],"latex-tlmgr-opts":[],"latex-input-paths":[],"latex-output-dir":null,"link-external-icon":false,"link-external-newwindow":false,"self-contained-math":false,"format-resources":[],"notebook-links":true},"pandoc":{"standalone":true,"wrap":"none","default-image-extension":"png","to":"html","toc":true,"embed-resources":true,"output-file":"feedback.html"},"language":{"toc-title-document":"Table of contents","toc-title-website":"On this page","related-formats-title":"Other Formats","related-notebooks-title":"Notebooks","source-notebooks-prefix":"Source","other-links-title":"Other Links","code-links-title":"Code Links","launch-dev-container-title":"Launch Dev Container","launch-binder-title":"Launch Binder","article-notebook-label":"Article Notebook","notebook-preview-download":"Download Notebook","notebook-preview-download-src":"Download Source","notebook-preview-back":"Back to Article","manuscript-meca-bundle":"MECA Bundle","section-title-abstract":"Abstract","section-title-appendices":"Appendices","section-title-footnotes":"Footnotes","section-title-references":"References","section-title-reuse":"Reuse","section-title-copyright":"Copyright","section-title-citation":"Citation","appendix-attribution-cite-as":"For attribution, please cite this work as:","appendix-attribution-bibtex":"BibTeX citation:","title-block-author-single":"Author","title-block-author-plural":"Authors","title-block-affiliation-single":"Affiliation","title-block-affiliation-plural":"Affiliations","title-block-published":"Published","title-block-modified":"Modified","title-block-keywords":"Keywords","callout-tip-title":"Tip","callout-note-title":"Note","callout-warning-title":"Warning","callout-important-title":"Important","callout-caution-title":"Caution","code-summary":"Code","code-tools-menu-caption":"Code","code-tools-show-all-code":"Show All Code","code-tools-hide-all-code":"Hide All Code","code-tools-view-source":"View Source","code-tools-source-code":"Source Code","tools-share":"Share","tools-download":"Download","code-line":"Line","code-lines":"Lines","copy-button-tooltip":"Copy to Clipboard","copy-button-tooltip-success":"Copied!","repo-action-links-edit":"Edit this page","repo-action-links-source":"View source","repo-action-links-issue":"Report an issue","back-to-top":"Back to top","search-no-results-text":"No results","search-matching-documents-text":"matching documents","search-copy-link-title":"Copy link to search","search-hide-matches-text":"Hide additional matches","search-more-match-text":"more match in this document","search-more-matches-text":"more matches in this document","search-clear-button-title":"Clear","search-text-placeholder":"","search-detached-cancel-button-title":"Cancel","search-submit-button-title":"Submit","search-label":"Search","toggle-section":"Toggle section","toggle-sidebar":"Toggle sidebar navigation","toggle-dark-mode":"Toggle dark mode","toggle-reader-mode":"Toggle reader mode","toggle-navigation":"Toggle navigation","crossref-fig-title":"Figure","crossref-tbl-title":"Table","crossref-lst-title":"Listing","crossref-thm-title":"Theorem","crossref-lem-title":"Lemma","crossref-cor-title":"Corollary","crossref-prp-title":"Proposition","crossref-cnj-title":"Conjecture","crossref-def-title":"Definition","crossref-exm-title":"Example","crossref-exr-title":"Exercise","crossref-ch-prefix":"Chapter","crossref-apx-prefix":"Appendix","crossref-sec-prefix":"Section","crossref-eq-prefix":"Equation","crossref-lof-title":"List of Figures","crossref-lot-title":"List of Tables","crossref-lol-title":"List of Listings","environment-proof-title":"Proof","environment-remark-title":"Remark","environment-solution-title":"Solution","listing-page-order-by":"Order By","listing-page-order-by-default":"Default","listing-page-order-by-date-asc":"Oldest","listing-page-order-by-date-desc":"Newest","listing-page-order-by-number-desc":"High to Low","listing-page-order-by-number-asc":"Low to High","listing-page-field-date":"Date","listing-page-field-title":"Title","listing-page-field-description":"Description","listing-page-field-author":"Author","listing-page-field-filename":"File Name","listing-page-field-filemodified":"Modified","listing-page-field-subtitle":"Subtitle","listing-page-field-readingtime":"Reading Time","listing-page-field-wordcount":"Word Count","listing-page-field-categories":"Categories","listing-page-minutes-compact":"{0} min","listing-page-category-all":"All","listing-page-no-matches":"No matching items","listing-page-words":"{0} words"},"metadata":{"lang":"en","fig-responsive":true,"quarto-version":"1.4.549","page-layout":"full","theme":"flatly","title":"Feedback"},"extensions":{"book":{"multiFile":true}}}},"projectFormats":["html"]}
\ No newline at end of file
+{"title":"Feedback","markdown":{"yaml":{"title":"Feedback","format":{"html":{"embed-resources":true}}},"headingText":"Feedback","containsRefs":false,"markdown":"\n\n::: {.callout-note collapse=\"false\"}\nThis guidance is an ALPHA draft. It is in development and we are still working to ensure that it meets user needs.\n\nPlease get in touch with feedback to support the guidance by creating a [GitHub Issue](https://github.com/best-practice-and-impact/analysis_project_documentation/issues) or [emailing us](mailto:ASAP@ons.gov.uk).\n:::\n\n\nWe are keen to understand the challenges faced by analytical teams in ONS when complying with good practice. To evaluate the effectiveness of this guidance, we would be grateful if you could fill in [a short survey](https://forms.office.com/e/ya2ZzRbGHM). \n\nWe appreciate your feedback. It will help us to make additional tools and resources on good practice for producing quality analysis.\n\nIf you have questions about this guidance or the survey please email ASAP@ons.gov.uk with \"analytical QA\" in the subject header."},"formats":{"html":{"execute":{"fig-width":7,"fig-height":5,"fig-format":"retina","fig-dpi":96,"df-print":"default","error":false,"eval":true,"cache":null,"freeze":false,"echo":true,"output":true,"warning":true,"include":true,"keep-md":false,"keep-ipynb":false,"ipynb":null,"enabled":null,"daemon":null,"daemon-restart":false,"debug":false,"ipynb-filters":[],"engine":"markdown"},"render":{"keep-tex":false,"keep-yaml":false,"keep-source":false,"keep-hidden":false,"prefer-html":false,"output-divs":true,"output-ext":"html","fig-align":"default","fig-pos":null,"fig-env":null,"code-fold":"none","code-overflow":"scroll","code-link":false,"code-line-numbers":false,"code-tools":false,"tbl-colwidths":"auto","merge-includes":true,"latex-auto-mk":true,"latex-auto-install":true,"latex-clean":true,"latex-max-runs":10,"latex-makeindex":"makeindex","latex-makeindex-opts":[],"latex-tlmgr-opts":[],"latex-input-paths":[],"latex-output-dir":null,"link-external-icon":false,"link-external-newwindow":false,"self-contained-math":false,"format-resources":[]},"pandoc":{"standalone":true,"wrap":"none","default-image-extension":"png","to":"html","toc":true,"embed-resources":true,"output-file":"feedback.html"},"language":{},"metadata":{"lang":"en","fig-responsive":true,"quarto-version":"1.1.163","page-layout":"full","theme":"flatly","title":"Feedback"},"extensions":{"book":{"multiFile":true}}}}}
\ No newline at end of file
diff --git a/.quarto/preview/lock b/.quarto/preview/lock
index 419c90a..005a7c0 100644
--- a/.quarto/preview/lock
+++ b/.quarto/preview/lock
@@ -1 +1 @@
-5004
\ No newline at end of file
+23076
\ No newline at end of file
diff --git a/.quarto/xref/INDEX b/.quarto/xref/INDEX
index 36dfc04..b80a38f 100644
--- a/.quarto/xref/INDEX
+++ b/.quarto/xref/INDEX
@@ -46,5 +46,8 @@
},
"assumptions_and_issues_log.qmd": {
"assumptions_and_issues_log.html": "eb9bc40b"
+ },
+ "assumptions_and_decisions_log.qmd": {
+ "assumptions_and_decisions_log.html": "17525110"
}
}
\ No newline at end of file
diff --git a/_quarto.yml b/_quarto.yml
index a06f4f3..0dc4a7e 100644
--- a/_quarto.yml
+++ b/_quarto.yml
@@ -18,6 +18,8 @@ website:
href: quality_questions_html_template.html
- text: "Download assumptions and decision log Excel template"
href: "assumptions_and_decision_log_template.xlsx"
+ - text: "Download a blank assumptions and decision log HTML template"
+ href: assumptions_decisions_html_template.html
- text: "Assumptions and decision log guide"
href: assumptions_and_issues_log.qmd
- text: "Example assumptions log"
diff --git a/apd_style.css b/apd_style.css
index 2ece33e..e3a34cb 100644
--- a/apd_style.css
+++ b/apd_style.css
@@ -19,3 +19,4 @@ table.simpleTable {
table.simpleTable tr:nth-child(even){
background: #EEEEEE;
}
+
diff --git a/assumptions_decisions_html_template.html b/assumptions_decisions_html_template.html
new file mode 100644
index 0000000..bad9145
--- /dev/null
+++ b/assumptions_decisions_html_template.html
@@ -0,0 +1,922 @@
+
+
+
+
+
+
+
+
+
+Assumptions and decisions log editable template
+
+
Introduction
+This set of templates supports analysis development and production by providing
+a structure for documentation. While most of the template should be self
+explanatory, this section sets out the purpose of each of the templates. If you
+have questions or suggestions for improvement, please use our Github repository
+to raise issues or emailing us.
+These templates are in development and your feedback is welcomed.
+
+
+
Template summaries
+
+
+
+
Template
+
Summary
+
+
+
Analysis overview
+
A table with a series of boxes to be
+ filled in by the owning team which sets out basic details about the
+ analysis.
+
+
+
+
Analysis map
+
A graphical representation of all
+ the inputs into the analysis, what processes they go through and the
+ outputs created by the analysis. These outputs should then, ideally,
+ be linked to planned or ongoing publications.
+
+
+
+
Roles and Responsibilities
+
Records when somebody took on a
+ governance role and if they reviewed the documentation relevant to the
+ responsibiltiies of the role. Also records past governance ownership
+ to ensure that handovers are recorded.
+
+
+
+
R&R resources
+
Guidance about what each assurance
+ role involves and templates to record agreement to carry out that role.
+
+
+
+
QA log
+
A table which allows the Analytical
+ Assurer to document planned Quality Assurance and confirm when it is
+ completed. Also has space for a short summary of the issues the Quality
+ Assurance raised. This information should be described more fully in
+ the decisions and issues register
+
+
+
+
Decisions and issues register
+
As issues arise in development,
+ decisions will have to be made about them. Issues can come from QA, or
+ be raised from within the team or by stakeholders. For example, there
+ may be concerns about the validity of one of the inputs used. This
+ requires a decision by the individuals in senior governance positions,
+ who will explain the evidence underpinning this decision. Often these
+ decisions will become assumptions, which are stored in the assumptions
+ log.
+
+
+
+
Assumptions Log
+
This table records the assumptions
+ made about the analysis. Assumptions will often be decisions made
+ because there is a need to simplify the real world so it can be analysed
+ or modelled. Wherever possible, such assumptions should have a
+ numerical value and an uncertainty range around the value. You should
+ also give your assumptions a quality RAG rating. When this is combined
+ with an assessment about how sensitive the analysis is to the assumption,
+ you get an indicative risk score. Use the risk score to inform how
+ resources are allocated to further research and improvement of the
+ assumptions.
+
+
+
+
Quality and sensitivity guide
+
An at-a-glance guide to quality
+ scoring. If you are not sure about the quality or sensitivity score of
+ an assumption, err on the side of caution and go for lower quality and
+ higher sensitivity.
+
+
+
+
Risk scoring guide
+
Uses the quality score and the
+ sensitivity analysis to estimate the risk of the assumption.
+
+
+
+* URL of the code repository on Gitlab or Github for the workflow.
+For multiple repositories, include the URLs for all relevant ones.
+Put each URL on a new line.
+
+
Analysis overview
+
Analysis basics
+
+
+
+
Analysis name
+
Enter name here...
+
+
+
Analysis purpose
+
Enter text here...
+
+
+
+
Owning team(s)
+
Enter text here...
+
+
+
+
Code repository URL*
+
Enter text here...
+
+
+
+
List of stakeholders
+
Enter text here...
+
+
+
+
+
Signoff details
+
+
+
+
Date of sign off
+
Name of responsible person
+
Role of responsible person
+
Comments
+
+
+
Enter date here...
+
Enter name here...
+
Enter role here...
+
Enter notes here...
+
+
+
+
I. Scoping the Analysis
+
+
+
+
+
Quality Question
+
Answer
+
Answer added by
+
Date of answer
+
Answer signed off by SRO?
+
Next review due on
+
Any change since last review?
+
+
+
Q1
+
What question does the analysis try to answer?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q2
+
Why do you need to answer this analysis question?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q3
+
Which organisational priorities does this analysis address?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q4
+
If you use a model, is it business critical?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q5
+
Who needs the answer to the analysis question?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q6
+
Who do you need to consult to make sure you meet the right user needs?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q7
+
How will you know you have answered the analysis question correctly?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q8
+
What is the estimated time and resource required to answer the analysis question (in months and FTE)?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q9
+
What is the impact if the analysis is not done now?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q10
+
What is the impact if the analysis is not done correctly?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q11
+
Name the commissioner, senior responsible owner and analytical assurer of this
+ analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q12
+
What tools and resources will you use in production? Are they the best for the job?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q13
+
Do you have the right internal and external resources and capability to deliver the analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q14
+
What are the anticipated risks of the analysis? Have you discussed these risks with customers and stakeholders?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q15
+
Is there a contingency plan prepared if your mitigation plans fail?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q16
+
Do the data and analysis comply with ethical requirements?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q17
+
What relevant questions are outside the scope of the analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q18
+
How will you peer review and assure the analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q19
+
Will external experts be involved in development and scrutiny of analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
+
II. Design
+
+
+
+
+
Question
+
Answer
+
Answer added by
+
Date of answer
+
Answer signed off by SRO?
+
Next review due on
+
Any change since last review?
+
+
+
Q20
+
Is there a simple, plain English description of what the analysis is for and what it does?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q21
+
Does the analysis have a logic flowchart which explains the end-to-end steps in the workflow?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q22
+
When do you expect to start and finish each stage of analysis: data collection, processing, quality assurance, analysis and dissemination?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q23
+
Does any part of the analysis rely on manual processing? Have you considered the cost and benefits of fully automating the process?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q24
+
What happens if team members, reviewers or users find a mistake in the analysis?
+ Do you have a clear and efficient process for addressing issues and preventing them from happening again?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q25
+
Have you assessed uncertainty?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
+
III. Doing and Checking the Analysis
+
+
+
+
+
Question
+
Answer
+
Answer added by
+
Date answer added
+
Answer signed off by SRO?
+
Next review due on
+
Any change since last review?
+
+
+
Q26
+
How will the data in the analysis be processed before and during use?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q27
+
Is the data appropriate given the methods selected?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q28
+
What are the strengths and limitations of the data you use?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q29
+
Is there a robust relationship between your team and data providers? Do data providers understand how and why you use their data?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q30
+
Do you understand how data providers collect, process and quality assure the data you use?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q31
+
Is there a formal agreement to set out data content, when and how you will get the data? If not, why not?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q32
+
Do you know what quality checks are carried out on the data before you receive them?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q33
+
How will you work with your data provider when your data requirements change?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q34
+
How do you know if your data provider makes a change to their systems or processes which could impact the data you receive or the analysis you produce?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
+
Q35
+
How did you choose the methods for the analysis? How do you know the methods you use are appropriate?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q36
+
Have reasonable alternative methods been explored and rejected for good reasons?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q37
+
How do you know that your analysis is working correctly?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q38
+
Can you describe the assumptions of your analysis, when they were made and who made them and signed them off?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q39
+
How are assumptions validated and assured before you apply them?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q40
+
How do you measure and report uncertainty in your analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q41
+
Have you considered the implications of relevant, unquantified uncertainties?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q42
+
Can you explain the impact of your analysis on downstream processes? Are there risks around these dependencies?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q43
+
Is all or part of the analysis reliant on a single person?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q44
+
Is it clear why important decisions about the analysis were made, who made them and when?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q45
+
If changes need to be made to code or datasets, is it easy to track who made the changes and when and why they were made?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q46
+
Would another analyst be able to reproduce your analysis output or continue the work (without talking to you first)?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q47
+
Do you use internal peer review to check scripts and code, documentation, implementation of methods, processes and outputs?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q48
+
Is your code and analysis ever peer reviewed by someone outside your team or organisation?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q49
+
What is your assessment of the quality of your analytical outputs?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q50
+
How do you assure yourself that the analysis you do is correct?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q51
+
Do the outputs of your analysis align with similar findings from elsewhere? If not can you explain why?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q52
+
If you find outliers or unusual trends in the data, what steps do you take to investigate them?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
+
IV. Delivery
+
+
+
+
+
Question
+
Answer
+
Answer added by
+
Date answer added
+
Answer signed off by SRO?
+
Next review due on
+
Any change since last review?
+
+
+
Q53
+
Can you give a clear account of what can and cannot be inferred from the analysis?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q54
+
Have you assessed the limitations of the data and analysis and set out how they affect the quality and use of the outputs?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q55
+
Have you sense checked outputs with user groups and stakeholders?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q56
+
Is uncertainty about data quality, assumptions and methodology clearly communicated to users?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q57
+
Are the implications of unquantified uncertainties communicated to users?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q58
+
Is workflow documentation including technical guides and code repositories publicly available?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q59
+
Does the technical guide and documentation explain how to run the analysis to obtain valid outputs?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q60
+
Have you fully documented the analysis code to comply with good practice?
+
Enter your answer here...
+
Enter full name
+
Enter date
+
Yes/No
+
Enter next review date
+
Enter text
+
+
+
Q61
+
Is there a clear feedback mechanism so users can report back on the suitability of outputs?