2012-08-01 51 views
1

是否有任何代码自我记录系统 for R?R中的自编码代码?

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

除了在R中使用sweave或knitr之外,还有其他的方法吗?

回答

3

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

+0

嘿查理,谢谢你的回答。我实际上在我的报告中一直使用Sweave和knitr,我想看看是否有其他方式。 – Sam 2012-08-01 01:04:11

+0

@ Sepehr:你还需要什么? – 2012-08-01 01:28:30

+0

Hi @DavidRobinson:缺少的部分是弄清楚如何记录数据清理步骤,Ari的答案似乎是一个解决方案。 – Sam 2012-08-01 01:40:32

1

如果您选择将您的分析整理为包,您可以使用roxygen2来记录您的代码和数据。

+0

谢谢卡斯滕。 – Sam 2012-08-01 01:33:49

4

我建议将你的代码和数据集捆绑在一个R包中。第一次做这件事时学习曲线非常陡峭,但如果你在问到“我怎样才能更好地管理这些代码文档的事情”,那么你很可能会冒险尝试。

另外,不打字?myOwnFunction?myOwnDataset,并且具有相应的帮助文件弹出的想法动听(就像当你这样做?mean?iris呢)?

+0

它的确如此。我一直在寻找的缺失部分是弄清楚如何记录数据集清洁步骤。阿里的答案似乎是一个解决方案。再次感谢你Josh。 – Sam 2012-08-01 01:38:39

+0

另外,如果您有一些可能具有普遍用途的功能,请使用CRAN软件包将它们返回社区。我发现这样做的过程(以及调试,功能添加和泛化)经常会使这些功能对我自己的项目更有用。 – 2012-08-01 01:39:26