评论 R pipeline %>% 的最佳实践

Question

在用R和dplyr/tidyr写长流水线的时候，有没有人找到添加注释的好方法？

我知道函数语法已经非常具有表现力，但有时多个动作可能 "grouped" 在一起，我想知道是否最好在多个管道中用它们之间的注释来打破整个事情，或者是否有是一种在管道中很好地格式化注释的方法。

Answer 1

不是真正的答案，但评论太长了--

我个人只是将我的评论放在管道中的命令之间。例如：

object %>%
  command1 %>%

  #* Comment

  command2 %>%
  command3 %>%

  #* Perhaps a 
  #* Really long
  #* Comment

  command4

对我来说，关键是将您的评论缩进到与它讨论的代码相同的水平，这样我就可以想象它是一个块的一部分。

Answer 2

或者：

object %>%
  command1 %>%  #* Comment
  command2 %>%
  command3 %>%   #* Perhaps a 
                 #* Really long
                 #* Comment
  command4

不过，老实说，我认为这种做法通常评论太多，类似于：

# increment x by 1
x <- x + 1

也就是说，您应该假设阅读您的代码的任何人都可以评估代码，并且应该只真正使用注释来获得更大的想法。例如

# In this section I calculate summaries and cummulative statistics of of X,Y,Z by factors A,B. 
# And then plot them. Note the plots exhibit ...
object %>%
  command1 %>%  
  command2 %>%
  command3 %>%  
  command4

ggplot(...) + geom_bar(...) + facet_grid(...) + theme(...)

如果您确实需要进行大量注释，那么您的代码可能对于交互式使用来说太复杂了。您可能应该将其放入可概括的函数中，并记录该函数。

评论 R pipeline %>% 的最佳实践

Best practices to comment R pipeline %>%

r

dplyr

tidyr