在R程序包记录特(中缀)功能(Documenting special (infix) functio

2019-10-20 11:22发布

在前面的帖子 ,我问了一下在R封装宣布这样的功能,使他们的工作。 已经成功了,我现在想记录一个这样的功能。

我创建了一个Rd与函数名的文件作为标题,但在运行时CHECK ,我得到以下警告:

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

我试了几个名字,如%IN%.Rd'%IN%'.Rd ,都无济于事。 如何使这项工作的任何提示?

Answer 1:

在转到导向肯定是2.1.1节“归档功能” [1]的“书写R附加”手册的。 作为@joran在评论中指出的重要组成部分,也许是使用的\alias 。 据“写作R附加”手册%的需要,以便至少进行转义\alias ,并在文本。 关于\name它指出:“[名称不应包含]‘!’ '|' 也不“@”,并避免与HTML帮助系统它不应该包含“/”,也不是一个空间可能出现的问题。(胶乳特殊字符是允许的,但也可以不在索引正确地核对。)” [2]和关于\alias :“百分比和左大括号需要用反斜杠转义。” [3]



文章来源: Documenting special (infix) functions in R packages