记录签名包含`< -`类的S4方法的正确方法是什么?

时间:2014-03-10 06:44:12

标签: r s4 roxygen2

Formula.tools 包中,我为A< -B等表达式定义并记录rhs方法。

#' @rdname formula.parts
#' @aliases rhs,set-method
setMethod( 'rhs', '<-', function(x) x[[3]] )

(n.b。签名列表'&lt; - '没有错,这里。它实际上是这个赋值语句的类。)

对于这个S4方法,roxyger2-3.1.0在 man / formula.parts.Rd 中生成以下内容:

\S4method{rhs}{<-}(x)

我认为正确的文档标记应该是:

\S4method{rhs}{`<-`}(x) 

有没有办法强制roxygen2生成正确的Rd语法?我有点挣扎,但找不到办法。

背景

  • R-3.0.1
  • roxygen-3.1.0

1 个答案:

答案 0 :(得分:0)

我在向roxygen开发者报告这个issue之后回答了我自己的问题。这证实在roxygen2-4.0.0之前不起作用。他们在一天内推出补丁。 (太棒了!)Roxygen2现在为&lt; - 的签名生成正确的Rd语法。

附加说明: 升级到roxygen2-4.0.0需要R> = 3.0.2和最新版本的Rcpp。