Comments - where to

library(tidyverse)

── Attaching core tidyverse packages ──────────────────────── tidyverse 2.0.0 ──
✔ dplyr     1.1.4     ✔ readr     2.1.4
✔ forcats   1.0.0     ✔ stringr   1.5.1
✔ ggplot2   3.4.4     ✔ tibble    3.2.1
✔ lubridate 1.9.3     ✔ tidyr     1.3.0
✔ purrr     1.0.2     
── Conflicts ────────────────────────────────────────── tidyverse_conflicts() ──
✖ dplyr::filter() masks stats::filter()
✖ dplyr::lag()    masks stats::lag()
ℹ Use the conflicted package (<http://conflicted.r-lib.org/>) to force all conflicts to become errors

library(ggplot2)
library(DiagrammeR)

1 Hvor i din R kode og Quarto dokumenter skal du skrive kommentarer?

Øvelse #1

Hvad tænker du om disse kommentarer og hvor de er placeret? Vil koden virke?

# this comment definitely okay
x <- 2 + 2

# ...but is the following okay?
tibble(x=1:10, y=2:11) %>% # ..is it okay, mid-pipe?
  filter(y>5 & # and how about breaking in the middle..
  x != 9) # ..of a statement like 'filter'?

# A tibble: 5 × 2
      x     y
  <int> <int>
1     5     6
2     6     7
3     7     8
4     8     9
5    10    11

Øvelse #1 Svar

Sådan ser output ud fra koden herover:

FIX THIS !!

…så koden fungerer sådan set uden fejl - R er relativt tolerant ift hvor du placerer dine kommentarer, men er det god praksis?

Kommentarerne er syntaktisk okay … men de gør det ikke nemmere for mennesker at læse koden. Det blev faktisk unødigt meget sværere. Så kig herunder og se hvordan det kan gøres simplere:

Keep it simple!

# Kommentar linjer før koden
# kan dække flere linjer og
# vil ikke være forstyrrende
# når du læser kode ... god praksis!

x <- 2 + 2 # brug kun inline kommentarer sparsomt
y <- x^2 - c(2, 5, 8, 10:14) # ..de forstyrrer