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

Jad*_*ace 2 metadata r metaprogramming

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

问题不在于代码丑陋或没有注释——每一行都有注释解释正在做什么以及为什么。它也是有组织的——它遵循一个非常可预测的结构。我所困扰的是所有垂直滚动。这似乎已经过时了。当我编写单词或乳胶文档时,我可以创建被软件识别为索引点的标题。这些索引点随后显示在目录中。

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

Joh*_*zer 5

如果你使用RStudio,你可以这样做。您需要使用这样的注释并显示文档大纲(在源代码旁边)

#library----

#some code---- 


#example----
Run Code Online (Sandbox Code Playgroud)

在此输入图像描述