在 R 中扩展原始函数时如何使用 @inheritParams答案

【问题标题】：How to use @inheritParams when expanding primitive functions in R在 R 中扩展原始函数时如何使用 @inheritParams
【发布时间】：2017-01-09 11:07:12
【问题描述】：

我想记录一个使用 R S4 系统的新方法，例如sqrt()：

##' Extend sqrt
##'
##' @title sqrt for myClass
##' @inheritParams sqrt
##' @return A numeric vector.
##' @exportMethod sqrt
##' 
setMethod(f = 'sqrt',
          signature = 'myClass',
          definition = function(x) {
            ...
          })

当我执行devtools::document() 时，我收到了类似Warning: @inheritParams: can't find topic sqrt 的警告消息。我想知道在这种情况下如何正确使用@inheritParams。

【问题讨论】：

标签： r s4 roxygen2

【解决方案1】：

这是一个古老的话题，但它也许可以帮助其他人......
据我所知，要从另一个函数复制参数定义，当该函数存在于您的包中时，您可以使用@inheritParams fun。
如果不是这种情况，您可以使用@inheritParams package::fun

【讨论】：