将devxygen2文档与devtools document函数一起使用会在包描述中自动生成Collate:字段，无论是否需要按特定顺序加载包库文件。
我正在使用一堆S4方法处理一个包，并希望确保在使用它们的任何方法或其他类之前加载类定义，我理解我可以使用Collate列表，但我不知道如何用roxygen2文档格式表明这一点。
roxygen2 manual引用了一个@include标记，但看起来它实际上可能只包含文档中的代码，例如，通过@examples标记添加外部示例。这可以用于指定方法的整理顺序吗？
答案 0 :(得分：13)
include标记用于表示一个文件需要另一个文件才能工作。 （名称包括可能不是最好的选择，但这就是生活）。如果你想确保在文件A之前加载文件B，那么请确保在A中@include B .Roxygen将负责订购整理字段以满足您的限制。
答案 1 :(得分：4)
我只是想通了如果你在R文件的顶部添加@include语句，它会干扰下一个roxygen2文档块，除非你用NULL跟随它，例如
#' @include something.R
NULL
#' Documenting a function
#'
#" It does something...
#'
#' @param ...
#'