记录 R 包中的特殊（中缀）函数答案

【问题标题】：Documenting special (infix) functions in R packages记录 R 包中的特殊（中缀）函数
【发布时间】：2014-09-06 06:32:30
【问题描述】：

在较早的post 中，我询问了有关在 R 包中声明此类函数并使其工作的问题。成功后，我现在正试图记录一个这样的功能。

我创建了一个以函数名称为标题的Rd 文件，但是在运行CHECK 时，我收到以下警告：

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

我尝试了几个名称，例如 %IN%.Rd 或 '%IN%'.Rd，但均无济于事。有关如何进行这项工作的任何提示？

【问题讨论】：

标签： r documentation package infix-notation

【解决方案1】：

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

【讨论】：

我认为这里的重要部分是使用\alias。尽管% 确实需要在文档本身的文本中进行转义。
真的，@joran。 \name{\%IN\%} 和 \alias{\%IN\%} 应该可以工作。
我能够使其与\alias{\%IN\%} 一起工作，并将文件重命名为IN.Rd。 \name 只会影响帮助页面的标题，不会产生任何错误。
我再次阅读了R 手册中的第 2.1.1 节“记录功能”。关于name，它指出：“[名称不应包含]'！''|'或'@'，并且为避免HTML帮助系统可能出现的问题，它不应包含'/'或空格。（LaTeX特殊字符是允许的，但可能无法在索引中正确排序。）”和关于alias：“百分比和左大括号需要用反斜杠转义。” (2014-07-16T06:34+02:00)
感谢您的澄清