使用roxygen2时如何指定加载S4方法的顺序

Question

我已经多次遇到以下问题。

假设您有两个类，classA 和 classB 在以下文件 classA.R 中描述：

#' the class classA
#'
#' This is a class A blabla
#' \section{Slots}{\describe{\item{\code{A}}{a Character}}}
#' @ name classA
#' @rdname classA
#' @exportClass classA
setClass("classA",representation(A="character"))

还有classB.R

#' the class classB
#'
#' This is a class B blabla
#' \section{Slots}{\describe{\item{\code{B}}{an object of class A}}}
#' @ name classB
#' @rdname classB
#' @exportClass classB
setClass("classB",representation(B="classA"))

我相信roxygen2 按字母顺序阅读了这些文件，但事实并非如此。如果我尝试构建包，我可能会收到以下错误：

roxygenize("./myExample")
Error in getClass(Class, where = topenv(parent.frame())) :
   "ClassA" is not a defined class

我如何确保roxygenize() 知道读取文件的顺序，即应该先读取哪个类定义？

---

注意：我知道我回答了自己的问题。那是因为我经常遇到这个问题，并且在查看roxygen2的代码后意识到了正确的方法。因此，作为参考，这是我的发现。

Answer 1

有两种方法可以实现：

如?collate_roclet 中所述，您可以使用@include 标记指定应在哪个类之前读取哪个类。在这种情况下，您可以在文件classB.r 中在实际的 R 代码之前添加以下行：

#' @include classA.r

这些标签专门用于更新DESCRIPTION文件中的Collate字段，是处理问题的推荐方法。

在某些情况下，依赖关系可能非常复杂，您希望自己保持概览，而不是完全依赖在代码库中添加 @include 标签。在这种情况下，您只需在 DESCRIPTION 文件的末尾指定 Collate 字段，如下所示：

Package: myExample
Type: Package
...
Collate:
    'classA.R'
    'classB.R'

函数roxygenize() 首先检查DESCRIPTION 文件，然后按照指定的顺序首先加载那里指定的任何文件。然后才加载包的其余部分。