通过CRAN检查避免警告

时间:2014-12-16 12:36:30

标签: r cran roxygen2

我有一个R包,其代码如下:

#' ...lots of roxygen documentation...
fn <- function(long, list, of=optional, arguments=optional) {...}
...
#' @export
#' @rdname fn
%f% <- fn

其中%f%将调用fn(long,list)。

使用R CRAN check检查时会发出警告:

* checking for code/documentation mismatches ... WARNING
Codoc mismatches from documentation object 'refset':
%f%
  Code: function(long, list, of=optional, arguments=optional) 
  Docs: function(long, list)
  Argument names in code not in docs:
    of=optional, arguments=optional

我不想为%f%编写单独的函数,因为这会增加代码复杂性。我也希望文档看起来像

Usage
...
long %f% list

就像现在一样,因为确实应该调用%f%。有没有办法让CRAN机器人高兴而不会混淆我的用户和做蠢事?

0 个答案:

没有答案
相关问题