r - 记录和导出 base 中已存在的 S4 泛型方法

Question

我的问题与 this unanswered question 中概述的问题基本相同这导致了一个归档并成功关闭的错误报告。

给定一个现有的 S4 generic ，就我而言 diag和 diag<- ，我希望导出 S4 class 的实现来自另一个包。

通读another thread我发现如果使用标签 @exportMethod diag<- 可以成功导出这些函数和 @exportMethod diag分别，但我无法使文档正常工作。

第一个线程和随后关闭的错误报告表明以下应该有效(在本例中为方法 show ):

#' @export
#' @aliases show,myPkgSpClass-method
#' @rdname myPkgSpClass-class
setMethod("show", "myPkgSpClass", function(object){ show(NA) })

但是，当我尝试对 diag 执行以下操作时，当我尝试构建时出现错误:

#' @export
#' @aliases diag<-,big.matrix-method
#' @rdname bigmatrix-diag
setMethod("diag<-", signature("big.matrix"), function(x, value) {
  SetDiag(x@address, value) # C++ implementation
  x
})

#' @export
#' @aliases diag,big.matrix-method
#' @rdname bigmatrix-diag
setMethod("diag", signature("big.matrix"), function(x) {
  GetDiag(x@address) # C++ implementation
})

错误: Error : Sections \title, and \name must exist and be unique in Rd files .

澄清:目前没有实现 diag可用于此类。

编辑:解决错误:我可以解决此错误，但必须破坏 diag 的现有文档.

如果我按如下方式添加唯一的名称和标题，它将成功构建:

#' @name diag
#' @title Extract and Replace the diagonal from a big.matrix
#' @aliases diag<-,big.matrix-method
#' @docType methods
#' @exportMethod diag<-
#' @rdname bigmatrix-diag
setMethod("diag<-", signature("big.matrix"), function(x, value) {
  SetDiag(x@address, value)
  x
})

#' @name diag
#' @title Extract and Replace the diagonal from a big.matrix.
#' @aliases diag,big.matrix-method
#' @docType methods
#' @exportMethod diag
#' @rdname bigmatrix-diag
setMethod("diag", signature("big.matrix"), function(x) {
  GetDiag(x@address)
})

但是当我输入 ?diag在 R session 中我得到错误:

Error in (function (path, query, ...) : replacement has length zero

我认为这意味着它 s finding two helpfiles for诊断`。

Answer 1

你能试试这个吗？

#' @name diag
#' @aliases diag,big.matrix-method
#' @export diag
#' @rdname bigmatrix-diag
setMethod("diag", signature("big.matrix"), function(x) {
  GetDiag(x@address) # C++ implementation
})