如何在Roxygen2中指明整理順序？

Question

將devxygen2文檔與devtools document函數一起使用會自動在包描述中生成Collate:字段，無論是否需要按特定順序加載包庫文件。

我正在使用一堆S4方法開發一個包，並希望確保在使用它們的任何方法或其他類之前加載類定義，我知道我可以使用Collate列表，但我不知道如何以roxygen2文檔格式表明這一點。

roxygen2手冊對@include標記進行了一些引用，但看起來它實際上可能只包含文檔中的代碼，例如，通過@examples標志添加外部示例。 這可以用於指定方法的整理順序嗎？

Answer 1

include標記用於表示一個文件需要另一個文件才能工作。 （名稱包括可能不是最好的選擇，但這就是生活）。 如果要確保文件B在文件A之前加載，請確保在A中包含@include B B.Roxygen將負責對整理字段進行排序以滿足您的限制。

Answer 2

我只是想通了如果你在你的R文件的頂部添加@include語句，它將干擾下一個roxygen2文檔塊，除非你用NULL跟隨它，例如

#' @include something.R
NULL

#' Documenting a function
#'
#" It does something...
#'
#' @param ...
#'