记录R包中的特殊(中缀)函数

时间:2014-07-15 21:47:46

标签: r documentation package infix-notation

在早期的post中,我询问了如何在R包中声明这些函数并使它们正常工作。成功之后,我现在正试图记录一个这样的功能。

我创建了一个Rd文件,其中包含函数的名称作为标题,但在运行CHECK时,我收到以下警告:

* checking for missing documentation entries ... WARNING
Undocumented code objects:
  '%IN%'

我尝试过多个名称,例如%IN%.Rd'%IN%'.Rd,但无济于事。关于如何使这项工作的任何提示?

1 个答案:

答案 0 :(得分:2)

goto指南肯定是“Writing R Extensions”手册的第2.1.1节“记录函数”[1]。正如@joran在评论中指出的那样,重要的部分可能是使用\alias。根据“编写R扩展”手册,%需要至少在\alias和文本中进行转义。关于\name它指出:“[名称不应包含]'!''|'也不是'@',并且为了避免HTML帮助系统可能出现的问题,它不应包含'/'或空格。(LaTeX允许使用特殊字符,但可能无法在索引中正确整理。)“[2]和约\alias:”需要使用反斜杠转义百分比和左括号。“[3] < / p>