r - R中的自文档代码？

Question

R是否有任何代码自记录系统？

我认为编写文档是任何统计分析中非常重要的一部分。你的代码中总有一些重要的细节或者数据清洗的步骤没有反映在最终的分析报告中。我想知道 R 中是否有任何有效的自记录系统（或方法）可以帮助我记录我的代码，包括我的注释 o 带有结构文件的代码，解释我的代码中使用的数据集（或表）的结构？

除了在 R 中使用 Sweave 或 knitr 之外，还有其他方法吗？

Answer 1

我建议将您的代码和数据集捆绑在一个 R 包中。第一次做的时候学习曲线很陡峭，但如果你问到“我怎样才能更好地管理这个代码文档”，你可能已经准备好冒险了。

另外，输入?myOwnFunctionor?myOwnDataset并弹出相应的帮助文件（就像您输入 or 时那样?mean）?iris听起来不是很吸引人吗？

Answer 2

您可以尝试将代码编写为 Sweave 或 kntr 文件，其中包含 LaTeX 文本和 R 代码。此过程会生成您的文本（包括您的代码）的 pdf，并执行您的代码。

Answer 3

如果您选择将分析组织为包，则可以roxygen2用于代码和数据的文档。