hadley / adv-r

Advanced R: a book
http://adv-r.hadley.nz
Other
2.36k stars 1.71k forks source link

Section 7.4.4 Execution environments: clarify by using, say, h(5) instead of h(1) #1745

Open HenrikBengtsson opened 2 years ago

HenrikBengtsson commented 2 years ago

In Section 7.4.4 Execution environments, there's:

https://github.com/hadley/adv-r/blob/dc49c3872c3530ac08716fd4f4c235b01266a4ce/Environments.Rmd#L656-L663

image

Here there are several uses of 1, 2, and 3 in different roles, e.g. the value of x, the value of a, and y, while also being used as labels for steps 1, 2, and 3 both in the code and in the graphs. This can complicate the parsing of the code and the graphs.

My suggestion is to initiate x with another value, to avoid clashing with the step labels, e.g.

h <- function(x) {
  # 1.
  a <- 4 # 2.
  x + a
}
y <- h(5) # 3.

would change the graph enough so that the binding values are x = 5, a = 4, and y = 9.