r_tutorials/w03a-R_tutorial.rmd

   1 ---
   2 title: "Week 3 R tutorial supplement"
   3 subtitle: "Statistics and statistical programming  \nNorthwestern University  \nMTS 525"
   4 author: "Aaron Shaw and Nick Vincent"
   5 date: "September 29, 2020"
   6 output:
   7   html_document:
   8     toc: yes
   9     number_sections: true
  10     toc_depth: 3
  11     toc_float:
  12       collapsed: false
  13       smooth_scroll: true
  14     theme: readable
  15   pdf_document:
  16     toc: yes
  17     toc_depth: '3'
  18 ---
  19
  20 ```{r setup, include=FALSE}
  21 knitr::opts_chunk$set(echo = TRUE)
  22 ```
  23 This supplementary tutorial goes through some additional examples and concepts that came up in our class session today (September 29, 2020). Nick and Aaron have tried to elaborate some examples that illustrate our responses.
  24
  25 Note that we don't provide any new examples related to the `apply()` family of functions (`lapply()`, `sapply()`, `tapply()`) as the upcoming R tutorials will develop some additional material on those.
  26
  27 If any of these examples are unhelpful and/or more confusing, we strongly encourage you to reach out to us for additional clarification and/or just disregard for the time being. As they say, "your mileage may vary."
  28
  29 # Using code chunks to break down a complicated function call
  30 One topic that came up today related into the use of chunks and breaking up functions to create more readable code.
  31
  32 Let's use openintro county data for this example.
  33 ```{r}
  34 library(openintro)
  35 data(county)
  36 ```
  37
  38 Let's look at three columns: `pop2000`, `pop2010`, and `pop2017`.
  39
  40 For some reason, let's imagine that a homework assignment has asked us to compute the mean population in the years 2000, 2010, and 2017, take the median of the three means, and then take the log of that median. Why not?
  41
  42 Let's start with the mean of one column...
  43
  44 ```{r}
  45 mean(county$pop2000)
  46 ```
  47 Whoops, okay, let's use that `na.rm` argument again.
  48
  49 ```{r}
  50 mean(county$pop2000, na.rm=TRUE)
  51 ```
  52 Ok, now we can grab just the three columns we want. Let's select a subset using brackets and variable names.
  53 ```{r}
  54 three_columns <- c('pop2000', 'pop2010', 'pop2017')
  55 three_columns
  56 ```
  57 Here's a very concise one-line command that solves our hypothetical homework problem:
  58 ```{r}
  59 log(median(sapply(county[three_columns],mean, na.rm=TRUE)))
  60 ```
  61 That works fine, but it can be quite confusing to read and I can't see what's happening under the hood. One approach to making things more readable and transparent might involve chunks breaking things down and creating a variable for each link in the chain of functions.
  62
  63 First I'll get the 3 means.
  64 ```{r}
  65 three_means <- sapply(county[three_columns], mean, na.rm=TRUE)
  66 three_means
  67 ```
  68 Then I get the median of those 3 means.
  69 ```{r}
  70 the_median <- median(three_means)
  71 the_median
  72 ```
  73 Then I take the log to get a final answer.
  74 ```{r}
  75 the_answer <- log(the_median)
  76 the_answer
  77 ```
  78 It's the same result with nice breaks and space to insert comments that explain what's going on.
  79
  80 # Formatting prettier code
  81
  82 Another way to make complex commands more readable is to use prettier formatting. Here's what that might look like:
  83 ```{r}
  84 log(
  85   median(
  86     sapply(
  87       county[three_columns],mean, na.rm=TRUE
  88       )
  89     )
  90   )
  91 ```
  92 Again, exactly the same output, exactly the same operations. Much easier to see how the functions are layered on top of each other.
  93
  94 # Automatic code "prettification"
  95
  96 We also talked about prettifying code using some built-in functions in RStudio within the `Code` dropdown menu. Specifically, you might look at the help documentation for the `Reflow comment`, `Reindent lines`, and `Reformat code` menu items or just try them out.
  97 We haven't developed examples yet that can actually benefit from these commands, but here's a chunk of code from the upcoming R tutorial that I've organized "concisely." For now, try not to worry about what the code would do, and instead focus on how it's formatted. It's very short and it works perfectly, but it's pretty hard to figure out what's going on:
  98
  99 ```{r}
 100 ## messy chunk
 101 my.mean <- function(z){z<-z[!is.na(z)];sigma<-sum(z);n<-length(z);out.value<-sigma/n;return(out.value)}
 102 ```
 103 When I highlight that block of code and click the `Reformat Code` command from the `Code` dropdown menu here's what it looks like:
 104 ```{r}
 105 ## messy chunk after reformatting
 106 my.mean <-
 107   function(z) {
 108     z <-
 109       z[!is.na(z)]
 110     sigma <- sum(z)
 111     n <- length(z)
 112     out.value <- sigma / n
 113     return(out.value)
 114   }
 115 ```
 116 It's exactly the same code. The only difference is how the text is organized. The result is far more readable.
 117
 118 You can also use an option in RMarkdown's code chunks to call `tidy=TRUE` *inside* the beginning of the chunk within the curly brackets. The following chunk of code looks terrible in the raw .rmd file—it's exactly the same "messy chunk" a few lines up. By including the `tidy=TRUE` option, it looks much better when it's knitted.
 119
 120 ```{r, tidy=TRUE}
 121 ## messy chunk with `tidy=TRUE` chunk option:
 122 my.mean <- function(z){z<-z[!is.na(z)];sigma<-sum(z);n<-length(z);out.value<-sigma/n;return(out.value)}
 123 ```