检查 R 包时出现意外的节标题“xamples”

Question

当我使用 R CMD check pkg_name 检查我自己的 R 包时，我收到如下警告：

unexpected section header '\examples'
unexpected section header '\keyword'

问题存在于 .Rd 文件中，我在其中为自己的数据编写了一些示例 R 代码（即 .Rd 文件用于 .RDdata 文件，而不是 .R 函数文件）。我想我们可以在下面的

{}

之间编写示例代码（“...”）：

\example{
...
}

不幸的是它无法通过包裹检查程序...提前感谢您的帮助！

Answer 1

我曾经在使用百分比符号时遇到过这个问题（

%

）。我试图为置信区间参数编写文档。然后我意识到我需要用反斜杠转义符号来解决错误（就像在 LaTeX 中一样）。因此，我将

%

替换为

\%

。这修复了错误。

Answer 2

.Rd 文件中的 { } 不匹配导致出现此问题。这是很难检测到的，在进行 R CMD 检查 pkg_name 之前，请确保你有匹配的对。

Answer 3

由于 roxygen2（幸运的是）支持 markdown，此错误消息可能会获得更多点击。如果从旧的 LaTeX 样式文件进行转换，某些 LaTeX 合法语法可能仍会隐藏在手动转换中。

从“word”转换为“word”解决了我的 Rd 解析错误（i.e.，将前导反引号更改为常规引号）。

Answer 4

当我错误地转义文档中的一些星号时，我生成了此错误。我输入了

1.*\.*\

而不是

1.\*.\*

。这导致文本行的末尾落在 {} 括号之外。