R中的自记录代码？

Question

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

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

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

Answer 1

我建议在R包中捆绑你的代码和数据集。第一次这样做会有一个陡峭的学习曲线，但如果你正处于要求的地步，“我怎样才能更好地管理这些代码文档的事情”，你可能已经准备好了。

另外，不打算键入?myOwnFunction或?myOwnDataset，并弹出相应的帮助文件（就像执行?mean或{{1}时一样听起来很吸引人？

Answer 2

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

Answer 3

如果您选择将分析整理为软件包，则可以使用roxygen2来获取代码和数据的文档。