如何在 R 中为代码创建内容索引

Question

为了我的工作，我必须编写超过 600 行的脚本。重要的是我的脚本对我的同事来说是可读的，但我注意到即使在阅读我自己的代码时我也需要滚动很多次才能找到某个函数。

问题不在于代码难看或没有注释——每一行都有注释解释正在做什么以及为什么。它也是有组织的——它遵循一个非常预测的 table 结构。我正在努力的是所有垂直滚动。似乎过时了。当我写 word 或 latex 文档时，我可以创建被软件识别为索引点的 headers。这些索引点随后会显示在 table 的内容中。

我可以在 R 中做类似的事情吗？是否有任何编程语言允许像这样索引点？维基百科也这样做，例如 link https://en.wikipedia.org/wiki/Meteorological_history_of_Hurricane_Patricia#Peak_strength 将带您到有关飓风峰值强度的段落。

Answer 1

我个人的技巧如下。我在 if(TRUE) 块中组织代码块，以便我可以折叠它们，例如在 RStudio 中。

# Step 1 of the pipeline
if(TRUE){
    message("Step 1 starting")
    Sys.sleep(0.1)
    i<-5
    i<-i+5
}

# Step 2 of the pipeline
if(TRUE){
    message("Step 2 of the pipeline")
    i<-i^2
    message("The results is ",i)
}

这样最后看起来更整洁:

Answer 2

如果你使用 RStudio，你可以这样做。您需要使用这样的注释并显示文档大纲（在来源旁边）

#library----

#some code---- 


#example----

如何在 R 中为代码创建内容索引

How do I create a content index for code in R

metadata

r

metaprogramming