-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path02-Analytical-Platform.Rmd
41 lines (30 loc) · 4.88 KB
/
02-Analytical-Platform.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# 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:
* 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.
## Summary of key terms
It will help you to be familiar with the following key terms:
- **Analytical Platform (AP)**: A data analysis environment providing modern tools and key datasets for MoJ analysts. AP contains training documents, resources, and access to various analytical software such as Rstudio and Jupyter.
- **Control Panel**: A place to navigate to Rstudio, Jupyter, S3 Buckets etc
- **RStudio**: Development environment for writing R code and R Shiny apps
- **JupyterLab**: Development environment for writing Python code including Python notebooks
- **Git**: Version control software that enables multiple people to make separate changes at the same time.
- **GitHub**: A web-based interface that uses Git and on which you publish and share your version-controlled code. You use Git locally (e.g. using RStudio) to track versions of your code, and then submit those changes to Github.
- **GitHub Repositories (Repo)**: Broadly similar to setting up a project folder on DOM1 shared drive to save work and share with others. Files on Github Repos represent the definitive version of the project. Everyone who works on the project makes contributions from their own personal versions.
- **Amazon S3**: A web-based cloud storage platform for storing data. Access to amazon S3 buckets can be managed.
- **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).
## Managing data
Once you have got set up on the Analytical Platform, do read about the following data management/handling topics:
- [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).
- [Information governance procedures](https://user-guidance.services.alpha.mojanalytics.xyz/information-governance.html#content) to be followed.
- Data [retention policies](https://user-guidance.services.alpha.mojanalytics.xyz/information-governance.html#data-retention) including when deleting data means they are permanently deleted.