cbo*_*tig 8 r documentation-generation roxygen2
使用带有devtools document函数的roxygen2文档会自动Collate:在包描述中生成一个字段,无论是否需要按特定顺序加载包库文件.
我正在使用一堆S4方法处理一个包,并且想要确保在使用它们的任何方法或其他类之前加载类定义,我知道我可以使用Collate列表,但我不知道如何以roxygen2文档格式表明这一点.
该roxygen2手册提出了一些参考的@include标签,但看起来像它可能实际上只是包含在文档中的代码,例如,用于通过添加外部的例子@examples标志.这可以用于指定方法的整理顺序吗？
had*_*ley 13
include标记用于表示一个文件需要另一个文件才能工作.(名称包括可能不是最好的选择,但这就是生活).如果要确保在文件A之前加载文件B,请确保@include B在A中.Roxygen将负责排序整理字段以满足您的限制.
我刚刚发现，如果你在 R 文件的顶部添加 @include 语句，它将干扰下一个 roxygen2 文档块，除非你在它后面加上 NULL 例如
#' @include something.R
NULL
#' Documenting a function
#'
#" It does something...
#'
#' @param ...
#'