对于包含 S4 类的包，推荐的包构建工作流程是什么？ [复制]

Question

可能重复：
How to properly document S4 class slots using Roxygen2

我想使用 R Studio 和 roxygen2 构建一个包含 S4 classes 的包。 当我在我的包中引入几个S4 classes 时，我已经使用roxygen2 语法记录了我的所有函数。

现在我意识到没有开箱即用的“@slot”功能。所以我想知道如何让我的所有文档都为其他功能工作，并像this thread 中建议的那样手动记录S4 classes？

或者换句话说，您会推荐哪种工作流程来构建一个包含老式函数和S4 classes 的包？

编辑：您是否建议将 R Studio 构建工具配置为不创建 .Rd 文件。 roxygenize 手动然后添加信息？这仍然会导致覆盖类的手动生成的 .Rd 文件......

Answer 1

关于 roxygen 和 S4 类的一般信息

roxygen 的第一个版本有一个@slot 标签，但该版本不再维护，而是支持roxygen2。所以不建议使用旧版本。

目前，roxygen2 并没有真正支持 S4 类。 Hadley 正在努力在roxygen3 (https://github.com/hadley/roxygen3) 中实现这一目标。如果您想试一试并感到勇敢：从 github 安装 roxygen3 并尝试开发版本。请注意，此版本最终会合并到roxygen2，因此问题会及时自行解决。

关于您的工作流程：

我个人总是觉得结合使用 roxygen 和手动编写的 .Rd 文件是个坏主意。但如果必须，您可以使用参数roxygen.dir 将 roxygen 的输出发送到不同的目录。这样你就可以将你想要的任何东西复制回包目录，而不会覆盖手动写入的文件。

roxygenise("./mypackage", roxygen.dir="./myroxygendir")

我要做的就是使用roxygen2 为您的类编写 Rd 文件，如您链接到的线程中所述。您不必出于某种未知原因而像您认为的那样手动添加它们。您只需像往常一样使用#' 来指示 Rd 块，并使用您链接到的线程中给出的任何内容。如果您想让插槽成为一个单独的部分，您可以使用@section 标记来实现，如下例所示。

一个如何使用roxygen2 添加插槽的示例：

#' The MY class
#'
#' This class blabla yadayada
#'
#'@section Slots:
#'  \describe{
#'    \item{\code{aslot}:}{Object of class \code{"numeric"}, containing 
#'whatever and a bit more}
#'    \item{\code{anotherslot}:}{Object of class \code{"character"}, containing
#' strings.}
#'  }
#'
#' @note Yes, you can add notes
#' @name MY 
#' @rdname MY
#' @aliases MY-class
#' @exportClass MY
#' @author Joris Meys
setClass("MY",
         representation=representation(aslot="numeric",
                                       anotherslot="character"
                                       )