2017-01-09 1 views
1

Я хочу документировать новый метод, использующий систему R S4, например sqrt():Как использовать @inheritParams при расширении примитивных функций в R

##' 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 в таком случае.

ответ

0

Это старая тема, но может возможно помочь другим ...
Насколько я знаю, чтобы скопировать параметр дефиницию из другой функции, вы можете использовать @inheritParams fun, когда функция существует в пакете.
Если это не тот случай, вы можете использовать @inheritParams package::fun

Смежные вопросы