Merge pull request #50 from NHSDigital/release/v1.7.0

Release v1.7.0

docs/about.md

@@ -17,7 +17,7 @@ RAP is becoming the standard for creating analytical outputs in government; comb
 
 The [Goldacre Review](https://www.gov.uk/government/publications/better-broader-safer-using-health-data-for-research-and-analysis), tasked with finding ways to deliver better, broader, and safer use of NHS data for analysis and research, identified RAP as the essential element to ensure high-quality analysis.
 
-The Data Science team at NHS England have been championing RAP practices and providing support for analytical teams across our organisation. We have published these resources in the spirit of openness and transparency, and in the hope that other teams in other organisations may find them useful. You can find out more about our incredible contributors on our [Acknowledgements](acknowledgements.md) page.
+The Data Science team at NHS England have been championing RAP practices and providing support for analytical teams across our organisation. We have published these resources in the spirit of openness and transparency, and in the hope that other teams in other organisations may find them useful. You can find out more about our incredible contributors on our [Acknowledgements](site_info/acknowledgements.md) page.
 
 Learn more about our [RAP service][19].
 

docs/introduction_to_RAP/RAP_in_health.md

@@ -0,0 +1,21 @@
+#RAP in Health
+
+When applying RAP to health data, unique challenges may arise, particularly concerning data safety. To support those currently engaged or interested in RAP within healthcare, NHS England has launched the [Health RAP Playbook]. This resource provides valuable advice and guidance tailored for individuals working specifically in health analytics.
+
+[Health RAP Playbook :fontawesome-solid-hospital:][Health RAP Playbook]{ .md-button .md-button--primary }
+
+The playbook is designed for a diverse audience, including analysts, Information Governance professionals, and members of the public seeking insights into how their healthcare data is being processed. Presently it covers essential topics such as:
+
+*  initiating RAP in health
+* considerations for exceptions to open sharing
+* insights into organisations already implementing RAP
+* guidance on the different levels of RAP that can be achieved and how
+
+Importantly, the playbook is intended to complement existing Government and NHS guidance, including the resources available on this website.
+
+It's worth noting that the [Health RAP Playbook] is currently in its **alpha testing phase**. Future releases are expected to broaden the scope of the playbook to cater to those less familiar with RAP. These upcoming topics include understanding what RAP entails in health, emphasising the significance of RAP in health, and providing specific resources for individuals already involved in RAP within smaller local teams.
+
+The team behind the playbook encourage users to [provide feedback] on the resource in order to improve the site.
+
+[Health RAP Playbook]: https://nhsengland.github.io/Health-RAP-Playbook-Alpha/
+[provide feedback]: mailto:datascience@nhs.net

docs/introduction_to_RAP/history_of_RAP.md

@@ -49,4 +49,6 @@ We thought it was worth laying out some of the key moments in RAP history - than
     * A good summary of the above by Jess Morley is [here](https://www.bennett.ox.ac.uk/blog/2022/07/bennett-insights-an-overview-of-uk-data-policy-developments)
 
 **2023**
-: [ONS publishes their RAP implementation plan, followed by other departments](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/departmental-rap-plans/)
+: [ONS publishes their RAP implementation plan, followed by other departments](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/departmental-rap-plans/)
+
+: The [Health RAP Playbook (Alpha)](https://nhsengland.github.io/Health-RAP-Playbook-Alpha/) is launched

docs/acknowledgements.md → docs/site_info/acknowledgements.md

@@ -1,9 +1,3 @@
----
-hide:
-  - navigation
-  - toc
----
-
 # Acknowledgements
 
 It's taken a lot of work to make the NHS England RAP Community of Practice and further the cause of RAP within NHS England more generally.
@@ -17,5 +11,6 @@ The **NHS England Data Science Skilled Team** has been the core of this work, bu
 | :-------------------------------------------------- | :------------------------------------------------------ | :------------------------------------------------------- | :-------------------------------------------------------- | :-------------------------------------------------------- |
 | **[Connor Quinn](https://github.com/connor1q)**     | **[Alistair Jones](https://github.com/alistair-jones)** | **[Daniel Goldwater](https://github.com/DanGoldwater1)** | **[Joseph Wilson](https://github.com/josephwilson8-nhs)** | **[Humaira Hussein](https://github.com/humairahussein1)**   |
 | **[Philip Hoang Le](https://github.com/philip-le)** | **[Sam Hollings](https://github.com/SamHollings)**      | **[Abbie Prescott](https://github.com/abbieprescott)**   | **[Xiyao Zhuang](https://github.com/xiyaozhuang)**        | **[Warren Davies](https://github.com/warren-davies4)**   |
+| **[Simone Chung](https://github.com/simonechung)** | **[Jennifer Struthers](https://github.com/jenniferstruthers1-nhs)** |||
 
 **You guys really put the "champion" in RAP Champion!!!**

docs/site_info/repo_traffic_information.md

@@ -0,0 +1,11 @@
+# GitHub Repository Traffic Statistics
+
+We store the files that make up this website in a public GitHub repository, [RAP Community of Practice](https://github.com/NHSDigital/rap-community-of-practice), and GitHub has a feature that allows you to view and analyse the traffic coming into your repository. We have compiled this information and displayed it for you below.
+
+Be sure to hover over the graphs for more information and click and drag to zoom in!
+
+## Views over Time
+<iframe src="https://raw.githack.com/jenniferstruthers1-nhs/rap_website_traffic/traffic/images/views_by_date.html" width="100%" height="500px"></iframe>
+
+## Average Views by Day of the Week
+<iframe src="https://raw.githack.com/jenniferstruthers1-nhs/rap_website_traffic/traffic/images/views_by_day_average.html" width="100%" height="500px"></iframe>

docs/site_info/website_traffic_information.md

@@ -0,0 +1,12 @@
+## How we collect data
+We use Usermaven as a cookie-less web traffic analytics tool to anonymously track our website vistors. This data helps us understand how the site is being used and how we can improve it. No personally identifiable information is stored by us or Usermaven and it is GDPR and CCPA compliant.
+
+For more information on Usermaven's cookie-less tracking and how it protects users privacy, click [here](https://usermaven.com/blog/cookieless-tracking){:target="_blank"}.
+
+
+## What data is collected
+Various different types of data are collected. This includes but is not limited to: the number of hits on each page, the entry and exit figures to each page, the location of our users, time spent on each page and device information such as browser and OS.
+
+The Usermaven free plan retains data for up to six months.
+
+We are happy to provide a link to the dashboard upon request, [email us!](mailto:england.rapchampions@nhs.net?subject=Request%20link%20to%20web%20traffic%20statistics)

docs/stylesheets/extra.css

@@ -95,3 +95,7 @@ table {
 html {
   scroll-behavior: smooth;
 }
+
+iframe {
+  border:none;
+}

docs/training_resources/git/making-code-discoverable.md

@@ -0,0 +1,58 @@
+# Making Code Discoverable using Github Topics.
+
+[comment]: <> (this is a mkdocs material style admonition - it will look better on the website)
+!!! tip "TLDR"
+    - Apply topics to each of your published repos following the ontology described below
+    - Focus initially on topics related to technique and domain - these are what people are usually most interested in
+    - Then, you add even more value by adding other topics. 
+    - There is a [website](https://nhsengland.github.io/open-health-statistics/) which scans github for NHS github repositories and displays them by topic - making it easier to find useful code
+
+[comment]: <> (this is a mkdocs material style admonition - it will look better on the website)
+??? question "Why should we care?"
+    - Applying topics for your repos will make it much easier to for you and others to find and reuse useful bits of code
+    - Using a common ontology will make the topics more useful - we will all be speaking the same language
+
+[comment]: <> (this is a mkdocs material style admonition - it will look better on the website)
+??? success "Pre-requisites"
+
+    |Pre-requisite | Importance | Note |
+    |--------------|------------|------|
+    |**None!**||Anyone can do this -though you need to [have published some code on github already](https://nhsdigital.github.io/rap-community-of-practice/implementing_RAP/how-to-publish-your-code-in-the-open/)|
+
+A key aim of RAP is to not only automate our pipelines, but to **re-use useful code in other work**. This relies on us publishing the code as publicly as possible, and then making it easy to find these useful bits of code. Topics in github can help with this, however we will get the most benefit from topics by using a common topic vocabulary to describe our GitHub code repos.
+
+The topic ontology described in this guide will ensure our code can be searched by:
+
+- language and tech used
+- what methods were used
+- whether or not the code is recent or old (and if it still updated)
+- what kinds of data the code was used with and where it came from
+
+[comment]: <> (this is a mkdocs material style admonition - it will look better on the website)
+!!! warning "The Differences between 'topics' and 'tags'"
+    In GitHub, tags and topics are different:
+
+	- **Topics** are labels applied to whole repos which describe them, like keywords. Each repo can up to twenty, and github is good at searching and sorting results by topics.
+	- **Tags** are labels applied to specific commits within a git repo, and it's how releases are made, e.g. v0.1.0 might be a tag applied to a specific commit locking in that this commit is Version 0.1.0.
+
+## Topics
+
+Our aim with topics is to allow people to find code which might be useful to them, so they can reuse it. With this in mind, they usually want to know what kind of data the code was used on, in which language, if it was using the compatible datastructures (e.g. pandas, or pyspark) and how recently it was made / updated (people are less trustworth of ancient, dead code).
+
+When applying topics to your code:
+
+-  we suggest starting with the priority 1 categories below, e.g. Domain Area and Technique, first, as these are people tend to be most concerned with
+- stick to the topics suggested below - this will ensure we get the most benefit out of them. If there are too many, it becomes meaningless. If there are important ones missing, raise an issue against this github repo with your suggestion for new topics
+
+| Priority | Category | Description | Example topics |
+|---|---|---|---|
+| 1 | Domain Area/ Datasets/ Data source | People will want to know what data these techniques have been applied to, if any. This might inspire them to do something similar, or highlight areas for collaboration. | secondary-care<br/> primary-care<br/>hospital-episode-statistics<br/> gpdpr<br/> civil-registration-of-deaths<br/> gdppr<br/> artificial (perhaps if it was using artifical data) |
+| 1 | Technique | People will want to know what kinds of data processing, analyses, etc. were done - this might be quite broad as it should cover the sorts of resuable code chunks people might want to look at. | clustering<br/> forecasting<br/> classification<br/> regression<br/> statistical-disclosure-control<br/> deduplication<br/> entity-resolution<br/> record-linkage<br/> summarisation<br/> data-cleansing<br/> data-validation<br/> hyperparameter-tuning<br/> artificial-data-generation<br/> etc. |
+| 2 | Technology | If I want to re-use someones Python or R code, and they made it using a different data structure to me, that might cause problems, hence it's important to describe them | _dplyr_<br> _numpy_<br> _notebook_<br> _pandas_<br> _polars_<br> _pyspark_<br> _pytorch_<br> _scipy_<br> _sklearn_<br> _sparklyr_<br> _sqlalchemy_<br> _sqlalchemy-orm_<br> _tensorflow_<br>  etc. |
+| 2 | Language | People often want to know if the code is using a language they know/use, and though GitHub can sometimes correctly identify the language used in the repo, if you have a lot of documentation or use certain languages (such as SQL), it can struggle. | python<br/> r<br/> sql |
+| 2 | Maturity | People might want to know if a codebase is made to a high standard, or by people who are just starting out. | _baseline-rap_<br/> _silver-rap_<br/> _gold-rap_ |
+| 2 | Opt-out of re-use | A tag for those people who want to publish their code, but make it clear that it is not optimised for re-use. | not-optimised-for-reuse |
+
+## Using topics to find useful repos (and code)
+
+You can search for repos by topic within github using the search bar (e.g., [as seen here](https://github.com/search?q=topic%3Anhs&type=repositories), with tips on github search syntax [here](https://docs.github.com/en/search-github/github-code-search/understanding-github-code-search-syntax)) or [you can use this helpful website](https://nhsengland.github.io/open-health-statistics/github-topics.html) which gathers the repos and topics from the various NHS organisations on GitHub.