Code styling

class: center, middle, inverse, title-slide

.title[
# Code styling
]
.author[
### Sara Mortara & Andrea Sánchez-Tapia
]
.institute[
### re.green | ¡liibre!
]
.date[
### 2022-07-21
]

---

## today

## more about good practices because we like it

---
class: middle, inverse, center

# standardization

---
class: middle, center

> "Good coding style is like using correct punctuation. You can manage without it, but it sure makes things easier to read."

Hadley Wickham

---

## the style

+ [Google's R style guide](https://google.github.io/styleguide/Rguide.html)
+ [tidyverse](https://style.tidyverse.org/)
+ [Advanced R](http://adv-r.had.co.nz/Style.html)

independent of the style, the important part is to be consistent!

---
## tools

+ shortcuts in your favorite editor for automatic identation
--

+ RStudio:
  + Ctrl+I `\(\rightarrow\)` Reindent lines
  + Ctrl+Shift+A `\(\rightarrow\)` Reformat code
--

+ package __formatR__

---
class: middle, center

> There are only two hard things in Computer Science: cache invalidation and naming things.

Phil Karlton

---

## function names

```
# Good
fit-models.R
utility-functions.R

# Bad
foo.r
stuff.r
```

---  
## script names

```
0-download.R
1-parse.R
2-explore.R
```

---
## object names
consistency above all!

+ alllowercase <- `plotpca`

+ period.separated <- `plot.pca`

+ underscore_separated <- `plot_pca`

+ lowerCamelCase <- `plotPca`

+ UpperCamelCase <- `PlotPca`

---
## object names

+ concisos e com conteúdo

+ variáveis `\(\rightarrow\)` substantivos

+ funções `\(\rightarrow\)` verbos

---
## consistency for functions, objects, and files

Example:

+ files: reading_data.R

+ functions: plotPca.R

+ variables: traits.data

---
class: middle, inverse, center

# sintax

---

## assigning objects <-

```r
#Bad
path_to_file = "data/data_raw.csv"
data = read.table(file = path_to_file, 
                  sep = ",", 
                  header = TRUE)

#Good
path_to_file <- "data/data_raw.csv"
data <- read.table(file = path_to_file, 
                   sep = ",", 
                   header = TRUE)
```

---

## spacing

```r
# Good
average <- mean(feet / 12 + inches, na.rm = TRUE)

# Bad
average<-mean(feet/12+inches,na.rm=TRUE)
```

---

## spacing exception

```r
# Good
x <- 1:10
base::get

# Bad
x <- 1 : 10
base :: get
```

---

## space after parentheses

```r
# Good
if (debug) do(x)
plot(x, y)

# Bad
if(debug)do(x)
plot (x, y)
```

---

## space after comma

```r
# Bad
x[1,]

# Good
x[1, ]
```

---

## indentation

```r
# Bad
data <- read.table(file = path_to_file, 
  sep = ",", 
header = TRUE)

# Not so good
data <- read.table(file = path_to_file, sep = ",", header = TRUE)

# Better
data <- read.table(file = path_to_file, 
                   sep = ",", 
                   header = TRUE)
```

---

## braces

when we create functions or loops

```r
long_function_name <- function(a = "a long argument", 
                               b = "another argument",
                               c = "another long argument") {
  # As usual code is indented by two spaces.
}
```

---

## code separation into sections

```r
# reading data #### OR
# reading data ----

## species ####
sp <- read.csv("data/especies.csv")

## environment ####
env <- read.csv("data/environment.csv")
```

---
class: middle, center, inverse

# comments

---

## comments

---

## comments

---
## comments

explain why more than what

+ communicate what the code __should__ do

+ comments for another developer or friend

+ comments to highlight doubts or potential problems

+ update comments along with content changes

---
## good practices

---
## good practices

1. be consistent in names
--

3. informatively comment the code
--

2. separate content and format commits

---
class: center, middle

# ¡Thanks!

<center>
<svg viewBox="0 0 512 512" style="position:relative;display:inline-block;top:.1em;fill:#A70000;height:1em;" xmlns="http://www.w3.org/2000/svg">  <path d="M476 3.2L12.5 270.6c-18.1 10.4-15.8 35.6 2.2 43.2L121 358.4l287.3-253.2c5.5-4.9 13.3 2.6 8.6 8.3L176 407v80.5c0 23.6 28.5 32.9 42.5 15.8L282 426l124.6 52.2c14.2 6 30.4-2.9 33-18.2l72-432C515 7.8 493.3-6.8 476 3.2z"></path></svg> [saramortara@gmail.com](mailto:saramortara@gmail.com) | [andreasancheztapia@gmail.com](mailto:andreasancheztapia@gmail.com)