Skip to content

Commit

Permalink
Made a few amendments to update the text
Browse files Browse the repository at this point in the history
  • Loading branch information
aidanmews committed Feb 5, 2025
1 parent 29d99ba commit 0efcf40
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 45 deletions.
20 changes: 6 additions & 14 deletions 02-Analytical-Platform.Rmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Analytical Platform {#AP}

## Introduction
To gain an overview of the Analytical Platform (AP) watch this 2-3 min [introductory video](https://www.youtube.com/watch?v=5467Hl3X9EI&t=95s), although please be aware that given it's a few years old some things have changed. In addition to the information in this chapter, you can:
To gain an overview of the Analytical Platform (AP) watch this 2-3 min [introductory video](https://www.youtube.com/watch?v=5467Hl3X9EI&t=95s), although please be aware that it's a few years old and much has changed since then. For more depth please see:

* Attend or work through yourself the Introduction: Using R on the Analytical Platform - see [the internal R training section](https://moj-analytical-services.github.io/ap-tools-training/CTG.html#r-training).
* Read [the Analytical Platform User Guidance](https://user-guidance.analytical-platform.service.justice.gov.uk/) which provides more technical details.
* The [Introduction to the Analytical Platform (link to recent recording)](https://justiceuk.sharepoint.com/:v:/s/InductionAcademy/EedsWmM09yRDvYWL1jVvgM8BhXw_77geVM3fx4KwNd70LQ?e=T4pPya), given as part of the Analysis Directorate Induction Academy.
* The Introduction to using R on the Analytical Platform - see [the internal R training section](https://moj-analytical-services.github.io/ap-tools-training/CTG.html#r-training) for more details.
* [The Analytical Platform User Guidance](https://user-guidance.analytical-platform.service.justice.gov.uk/).

## Summary of key terms
It will help you to be familiar with the following key terms:
Expand All @@ -20,19 +21,10 @@ It will help you to be familiar with the following key terms:
- **Slack**: Collaboration tool where you can get technical support for Analytical Platform tools such as R, Python, Git. You can share knowledge, submit admin requests and communicate quickly with other AP users.

## Getting set up
Follow the steps in the [Getting Started section of the Analytical Platform User Guide](https://user-guidance.services.alpha.mojanalytics.xyz/get-started.html#get-started). You need to:

- Set up a [Slack account](https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#2-create-slack-account).
- Set up a [GitHub account with two-factor authentication](https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#3-create-github-account).
- Set up a [Analytical Platform account](https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#4-access-the-analytical-platform).
- Set up [RStudio](https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#6-set-up-rstudio) to use R and/or [JupyterLab](https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#5-set-up-jupyterlab) to use Python.

You can learn more about GitHub by attending or working through yourself the Introduction to Git/GitHub - see [the internal Git/GitHub training section](https://moj-analytical-services.github.io/ap-tools-training/CTG.html#gitgithub-training).

For those that need to get set up to use Athena databases for SQL (in R or Athena) on the Analytical Platform, please follow the additional instructions in the “Training Requirements” section of the [Introduction to SQL training repository](https://github.com/moj-analytical-services/sql_training).
Follow the steps in the [Analytical Platform User Guidance Quickstart Guide](https://user-guidance.services.alpha.mojanalytics.xyz/get-started.html#get-started).

## Managing data
Once you have got set up on the Analytical Platform, do read about the following data management/handling topics:
Once you have got set up on the Analytical Platform, do read about the following data management/handling topics in the [Analytical Platform User Guidance](https://user-guidance.analytical-platform.service.justice.gov.uk/):

- [How data are held on the Analytical Platform and finding the data you need](https://user-guidance.services.alpha.mojanalytics.xyz/data/#dropShadow). You can read about the three different data storage options (Amazon S3, Curated databases and home directories).
- Working with [Amazon S3](https://user-guidance.services.alpha.mojanalytics.xyz/data/amazon-s3/#amazon-s3), [data FAQ](https://user-guidance.analytical-platform.service.justice.gov.uk/data/data-faqs/index.html), the [Data Uploader tool](https://user-guidance.analytical-platform.service.justice.gov.uk/tools/data-uploader/index.html#data-uploader) and [interacting with Amazon S3 via the Analytical Platform](https://user-guidance.analytical-platform.service.justice.gov.uk/data/amazon-s3/index.html#interacting-with-amazon-s3-via-the-analytical-platform).
Expand Down
6 changes: 5 additions & 1 deletion 03-Internal-Training-Group.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Coding Training Groups {#CTG}

Those working in Data and Analysis are recommended to take the internal training courses as they are run using the MoJ Analytical Platform and focus on topics of relevance to MoJ analysts. The main introductory R, SQL and Git/GitHub sessions are usually run live in February/March, June/July and October/November each year while you can also work through R, SQL, Git/GitHub and Python sessions yourself using the training material and/or recordings. There is also Python training you can work through yourself.
Those working in Data and Analysis Directorates are recommended to take the internal training courses as they are run using the MoJ Analytical Platform and focus on topics of relevance to MoJ analysts.

The main introductory R, SQL and Git/GitHub sessions are usually run live in February/March, June/July and October/November each year while you can also work through R, SQL, Git/GitHub and Python sessions yourself using the training material and/or recordings.

There's also an Introduction to the Analytical Platform - see the [Analytical Platform chapter](#AP) for more information.

## R Training

Expand Down
2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="MoJ coding training leads (the Analytical Platform team is not responsible for the content on this page)" />


<meta name="date" content="2025-01-29" />
<meta name="date" content="2025-02-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down
23 changes: 7 additions & 16 deletions docs/AP.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="MoJ coding training leads (the Analytical Platform team is not responsible for the content on this page)" />


<meta name="date" content="2025-01-29" />
<meta name="date" content="2025-02-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -139,10 +139,11 @@ <h1>
<h1><span class="header-section-number">2</span> Analytical Platform<a href="AP.html#AP" class="anchor-section" aria-label="Anchor link to header"></a></h1>
<div id="introduction" class="section level2 hasAnchor" number="2.1">
<h2><span class="header-section-number">2.1</span> Introduction<a href="AP.html#introduction" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>To gain an overview of the Analytical Platform (AP) watch this 2-3 min <a href="https://www.youtube.com/watch?v=5467Hl3X9EI&amp;t=95s">introductory video</a>, although please be aware that given it’s a few years old some things have changed. In addition to the information in this chapter, you can:</p>
<p>To gain an overview of the Analytical Platform (AP) watch this 2-3 min <a href="https://www.youtube.com/watch?v=5467Hl3X9EI&amp;t=95s">introductory video</a>, although please be aware that it’s a few years old and much has changed since then. For more depth please see:</p>
<ul>
<li>Attend or work through yourself the Introduction: Using R on the Analytical Platform - see <a href="https://moj-analytical-services.github.io/ap-tools-training/CTG.html#r-training">the internal R training section</a>.</li>
<li>Read <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/">the Analytical Platform User Guidance</a> which provides more technical details.</li>
<li>The <a href="https://justiceuk.sharepoint.com/:v:/s/InductionAcademy/EedsWmM09yRDvYWL1jVvgM8BhXw_77geVM3fx4KwNd70LQ?e=T4pPya">Introduction to the Analytical Platform (link to recent recording)</a>, given as part of the Analysis Directorate Induction Academy.</li>
<li>The Introduction to using R on the Analytical Platform - see <a href="https://moj-analytical-services.github.io/ap-tools-training/CTG.html#r-training">the internal R training section</a> for more details.</li>
<li><a href="https://user-guidance.analytical-platform.service.justice.gov.uk/">The Analytical Platform User Guidance</a>.</li>
</ul>
</div>
<div id="summary-of-key-terms" class="section level2 hasAnchor" number="2.2">
Expand All @@ -162,21 +163,11 @@ <h2><span class="header-section-number">2.2</span> Summary of key terms<a href="
</div>
<div id="getting-set-up" class="section level2 hasAnchor" number="2.3">
<h2><span class="header-section-number">2.3</span> Getting set up<a href="AP.html#getting-set-up" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>Follow the steps in the <a href="https://user-guidance.services.alpha.mojanalytics.xyz/get-started.html#get-started">Getting Started section of the Analytical Platform User Guide</a>. You need to:</p>
<ul>
<li>Set up a <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#2-create-slack-account">Slack account</a>.<br />
</li>
<li>Set up a <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#3-create-github-account">GitHub account with two-factor authentication</a>.<br />
</li>
<li>Set up a <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#4-access-the-analytical-platform">Analytical Platform account</a>.</li>
<li>Set up <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#6-set-up-rstudio">RStudio</a> to use R and/or <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/get-started.html#5-set-up-jupyterlab">JupyterLab</a> to use Python.</li>
</ul>
<p>You can learn more about GitHub by attending or working through yourself the Introduction to Git/GitHub - see <a href="https://moj-analytical-services.github.io/ap-tools-training/CTG.html#gitgithub-training">the internal Git/GitHub training section</a>.</p>
<p>For those that need to get set up to use Athena databases for SQL (in R or Athena) on the Analytical Platform, please follow the additional instructions in the “Training Requirements” section of the <a href="https://github.com/moj-analytical-services/sql_training">Introduction to SQL training repository</a>.</p>
<p>Follow the steps in the <a href="https://user-guidance.services.alpha.mojanalytics.xyz/get-started.html#get-started">Analytical Platform User Guidance Quickstart Guide</a>.</p>
</div>
<div id="managing-data" class="section level2 hasAnchor" number="2.4">
<h2><span class="header-section-number">2.4</span> Managing data<a href="AP.html#managing-data" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>Once you have got set up on the Analytical Platform, do read about the following data management/handling topics:</p>
<p>Once you have got set up on the Analytical Platform, do read about the following data management/handling topics in the <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/">Analytical Platform User Guidance</a>:</p>
<ul>
<li><a href="https://user-guidance.services.alpha.mojanalytics.xyz/data/#dropShadow">How data are held on the Analytical Platform and finding the data you need</a>. You can read about the three different data storage options (Amazon S3, Curated databases and home directories).</li>
<li>Working with <a href="https://user-guidance.services.alpha.mojanalytics.xyz/data/amazon-s3/#amazon-s3">Amazon S3</a>, <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/data/data-faqs/index.html">data FAQ</a>, the <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/tools/data-uploader/index.html#data-uploader">Data Uploader tool</a> and <a href="https://user-guidance.analytical-platform.service.justice.gov.uk/data/amazon-s3/index.html#interacting-with-amazon-s3-via-the-analytical-platform">interacting with Amazon S3 via the Analytical Platform</a>.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/CC.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="MoJ coding training leads (the Analytical Platform team is not responsible for the content on this page)" />


<meta name="date" content="2025-01-29" />
<meta name="date" content="2025-02-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down
6 changes: 4 additions & 2 deletions docs/CTG.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="MoJ coding training leads (the Analytical Platform team is not responsible for the content on this page)" />


<meta name="date" content="2025-01-29" />
<meta name="date" content="2025-02-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -137,7 +137,9 @@ <h1>
<section class="normal" id="section-">
<div id="CTG" class="section level1 hasAnchor" number="3">
<h1><span class="header-section-number">3</span> Coding Training Groups<a href="CTG.html#CTG" class="anchor-section" aria-label="Anchor link to header"></a></h1>
<p>Those working in Data and Analysis are recommended to take the internal training courses as they are run using the MoJ Analytical Platform and focus on topics of relevance to MoJ analysts. The main introductory R, SQL and Git/GitHub sessions are usually run live in February/March, June/July and October/November each year while you can also work through R, SQL, Git/GitHub and Python sessions yourself using the training material and/or recordings. There is also Python training you can work through yourself.</p>
<p>Those working in Data and Analysis Directorates are recommended to take the internal training courses as they are run using the MoJ Analytical Platform and focus on topics of relevance to MoJ analysts.</p>
<p>The main introductory R, SQL and Git/GitHub sessions are usually run live in February/March, June/July and October/November each year while you can also work through R, SQL, Git/GitHub and Python sessions yourself using the training material and/or recordings.</p>
<p>There’s also an Introduction to the Analytical Platform - see the <a href="AP.html#AP">Analytical Platform chapter</a> for more information.</p>
<div id="r-training" class="section level2 hasAnchor" number="3.1">
<h2><span class="header-section-number">3.1</span> R Training<a href="CTG.html#r-training" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>The following sessions are available; click on the links to view the latest recordings and GitHub repositories respectively. The first three are particularly recommended for new starters.</p>
Expand Down
9 changes: 4 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<meta name="author" content="MoJ coding training leads (the Analytical Platform team is not responsible for the content on this page)" />


<meta name="date" content="2025-01-29" />
<meta name="date" content="2025-02-05" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="apple-mobile-web-app-capable" content="yes" />
Expand Down Expand Up @@ -138,7 +138,7 @@ <h1>
<div id="header">
<h1 class="title">Analytical Platform and related tools training</h1>
<p class="author"><em>MoJ coding training leads (the Analytical Platform team is not responsible for the content on this page)</em></p>
<p class="date"><em>2025-01-29</em></p>
<p class="date"><em>2025-02-05</em></p>
</div>
<div id="summary" class="section level1 hasAnchor" number="1">
<h1><span class="header-section-number">1</span> Summary of available resources<a href="index.html#summary" class="anchor-section" aria-label="Anchor link to header"></a></h1>
Expand All @@ -149,8 +149,7 @@ <h2><span class="header-section-number">1.1</span> Analytical IT Tools Strategy<
<div id="analytical-platform" class="section level2 hasAnchor" number="1.2">
<h2><span class="header-section-number">1.2</span> Analytical Platform<a href="index.html#analytical-platform" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>The Analytical Platform is a data analysis environment, enabling the use of modern open source tools such as R and Python, and holding key datasets for MoJ analysts.</p>
<p>You can view a recent recording of the <a href="https://justiceuk.sharepoint.com/:v:/s/InductionAcademy/EedsWmM09yRDvYWL1jVvgM8BhXw_77geVM3fx4KwNd70LQ?e=T4pPya">Introduction to the Analytical Platform</a>, which was given as part of the Analysis Directorate Induction Academy.</p>
<p>Otherwise, to learn more about the Analytical Platform and to get up and running, go to the <a href="AP.html#AP">Analytical Platform chapter</a>. More extensive information is provided by the <a href="https://user-guidance.services.alpha.mojanalytics.xyz/#content">Analytical Platform user guidance</a>.</p>
<p>To learn more about the Analytical Platform and to get up and running, go to the <a href="AP.html#AP">Analytical Platform chapter</a>.</p>
</div>
<div id="coding-mentoring-scheme" class="section level2 hasAnchor" number="1.3">
<h2><span class="header-section-number">1.3</span> Coding Mentoring Scheme<a href="index.html#coding-mentoring-scheme" class="anchor-section" aria-label="Anchor link to header"></a></h2>
Expand Down Expand Up @@ -185,7 +184,7 @@ <h2><span class="header-section-number">1.6</span> Bite-sized sessions<a href="i
</div>
<div id="analytical-function-training" class="section level2 hasAnchor" number="1.7">
<h2><span class="header-section-number">1.7</span> Analytical Function training<a href="index.html#analytical-function-training" class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>There are many Analytical Function training opportunities for analysts including about specialist topics not presently covered internally. Examples useful for RAP practitioners include <a href="https://analysisfunction.civilservice.gov.uk/training/best-practice-in-programming-clean-code/">Best practice in programming – clean code</a> and a more lengthy <a href="https://analysisfunction.civilservice.gov.uk/training/introduction-to-unit-testing/">Introduction to unit testing</a> than currently available internally. You can learn more about such opportunities via:</p>
<p>There are many Analytical Function training opportunities for analysts including about specialist topics not presently covered internally. Examples useful for Reproducible Analytical Pipeline practitioners include <a href="https://analysisfunction.civilservice.gov.uk/training/best-practice-in-programming-clean-code/">Best practice in programming – clean code</a> and a more lengthy <a href="https://analysisfunction.civilservice.gov.uk/training/introduction-to-unit-testing/">Introduction to unit testing</a> than currently available internally. You can learn more about such opportunities via:</p>
<ul>
<li><a href="https://analysisfunction.civilservice.gov.uk/learning-development/learning-curriculum/">The Analytical Function Learning Curriculam</a></li>
<li><a href="https://analysisfunction.civilservice.gov.uk/training-courses/">The Analytical Function Training Courses</a></li>
Expand Down
Loading

0 comments on commit 0efcf40

Please sign in to comment.