Question

偶尔我会在R包中包含项目特定的代码。我使用Writing R Extensions建议的文档文件来记录代码的应用。

因此，一旦您设置了项目并对.Rd文件进行了所有编辑，在代码的情况下，如果没有重写或强烈复制粘贴所有文档文件，或者更糟糕的是代码结构更改，您如何管理无痛且干净的版本控制？

为了更详细，我当前的工作流程是我发出package.skeleton()，对.Rd文件进行编辑，后跟R CMD check和R CMD build。当我对代码进行更改时，我需要重做上面的内容，可能会附加＆＃39; .2.0.1＆＃39;或者为了保存前体版本的任何东西。在运行R CMD check命令之前，我需要非常小心地重新填充所有.Rd文件，以便对Tex文件进行干净的检查和完美的编译。这真的很愚蠢，有时真的很痛苦，例如如果你想解决所有的警告或乳胶有一个糟糕的一天。

你用什么技巧？请分享您的工作流程。

Answer 1

您正在寻找的解决方案是roxygen2。

RStudio提供handy guide，但是您可以简单地将函数记录在函数定义中：

#' Function doing something
#' Extended description goes here
#' @param x Input foo blah
#' @return A numeric vector length one containing foo
myFunc <- function(x) NULL

如果您正在使用RStudio（也可能是ESS？），Build Package命令会自动为您创建.Rd文件。如果没有，您可以阅读roxygen2文档以获取生成文档的命令。

如何用恩典管理R扩展/包文档（或者至少没有痛苦）

1 个答案: