现有仿制药的Roxygen文档

时间:2018-03-21 13:46:11

标签: r roxygen2

我为我在包中定义的S4类show()编写了一个myclass方法。我用roxygen2生成了类和方法的文档。一切都很好,除了我在R CMD检查结果中收到以下警告:

  

检查缺少的文件条目......警告
  未记载的S4方法:   通用'长度'和siglist' myclass'

如何记录我自己未编写的show通用文件?

1 个答案:

答案 0 :(得分:0)

最后,使用明确的@aliases@docType标签为我解决了这个问题。我的文档块现在看起来像这样:

#' Show method for objects of class \code{myclass}.
#'
#' @docType methods
#' @name show-myclass
#' @rdname show-myclass
#' @aliases show-myclass show,myclass-method
#'
#' @param x A \code{myclass} object.
#'
#' @export