将roxygen2文档与devtools document函数一起使用时,无论是否有必要按特定顺序加载软件包库文件,都会在软件包Description中自动生成Collate:字段。

我正在使用一堆具有S4方法的程序包,并希望确保在使用任何方法或其他类之前加载类定义,据我了解,我可以使用Collate列表进行此操作,但我不知道确保如何以roxygen2文档格式进行说明。

roxygen2 manual引用了@include标记,但是看起来它实际上可能仅包括文档中的代码,例如,用于通过@examples标志添加外部示例的代码。可以用于指定方法的整理顺序吗?

最佳答案

include标签用于声明一个文件需要另一个文件才能工作。 (名称include可能不是最好的选择,但这就是生活)。如果要确保文件B在文件A之前加载,请确保在文件A中的@include B。Roxygen将负责整理排序字段以满足您的限制。

09-05 14:51