woRkflowWorkshop.md 1.77 KB
Newer Older
Ben Anderson's avatar
Ben Anderson committed
1
2
3
4
5
6
# The woRkflow Workshop

1 hour (hopefully)

## To do before you come

7
8
9
10
11
12
13
14
 * install [RStudio](https://rstudio.com/products/rstudio/) and/or get yourself set up on https://rstudio.soton.ac.uk
 * then install:
    * here
    * drake
    * data.table
    * lubridate
    * hms
    * ggplot2 (or just install the whole tidyverse)
15
    * skimr
Ben Anderson's avatar
Ben Anderson committed
16
 * make sure you can log in to [git.soton.ac.uk](git.soton.ac.uk/)
Ben Anderson's avatar
Ben Anderson committed
17
 * check you have an ssh key set up on git.soton for the laptop/PC/server where you are going to use RStudio - see [rstudio's help](https://support.rstudio.com/hc/en-us/articles/200532077-Version-Control-with-Git-and-SVN) or [this one](https://happygitwithr.com/ssh-keys.html)
Ben Anderson's avatar
Ben Anderson committed
18
 * Make sure you have Teams - we will be using the screen sharing a lot
Ben Anderson's avatar
Ben Anderson committed
19
20
21
22
23
24
25

## On the day we will

 * fork the [woRkflow repo](https://git.soton.ac.uk/SERG/workflow) to your personal space on git.soton.ac.uk
 * clone your personal fork of the repo to the laptop/PC/server where you are going to use RStudio 
 * explore the repo to see what is in:
   * .env.R
Ben Anderson's avatar
Ben Anderson committed
26
27
28
29
   * /R
   * /Rmd - what's in:
     *  make_basicReport.R?
     *  basicReport.Rmd?
Ben Anderson's avatar
Ben Anderson committed
30
 * test /Rmd/make_basicReport.R and see why it doesn't work
Ben Anderson's avatar
Ben Anderson committed
31
32
33
34
35
    * test workflow::setup()
    * test workflow::tidyNum(1234)
 * build the repo as an R package using the RStudio -> Build menu (check build config for roxygen)
 * convince yourself that:
    * workflow::setup() now works
Ben Anderson's avatar
Ben Anderson committed
36
    * workflow::tidyNum(1234) now works
Ben Anderson's avatar
Ben Anderson committed
37
 * See if /Rmd/make_basicReport.R works now
Ben Anderson's avatar
Ben Anderson committed
38
 * work through /Rmd/make_basicReport.R and basicReport.Rmd to understand:
Ben Anderson's avatar
Ben Anderson committed
39
40
41
   * what drake is doing and how it helps
   * why data.table is really fast
   * why lubridate is so useful for dates and times
Ben Anderson's avatar
Ben Anderson committed
42
   * why you use drake to build stuff and Rmd to report it
Ben Anderson's avatar
Ben Anderson committed
43
44
45
   * how to get ggplot2 to make pretty plots
  
 * That's it :-)