检查R包时出现意外的部分标题'\examples'

Question

当我使用R CMD check pkg_name检查自己的R包时，我会得到类似于这样的警告：

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

问题出现在我的.Rd文件中，我在其中为自己的数据编写一些示例R代码（即.Rd文件是用于.RDdata文件而不是.R函数文件的）。 我认为我们可以将示例代码（“...”）写在下面的{}之间：

\example{
...
}

很遗憾，它无法通过软件包检查程序...非常感谢您的帮助！

- alittleboy

---

如果我们能够查看相关的.Rd文件，那将会非常有帮助... - Ari B. Friedman

我之前遇到过这个问题 - 问题是我忘记在 .Rd 文件中早些时候关闭了一个 {} 括号对。也许可以尝试检查一下这个？ - Edward

@AriB.Friedman：谢谢回复！我在我的.Rd文件中找到了问题。 - alittleboy

@Edward：是的，.Rd文件中确实存在{}不匹配的问题。非常感谢！ - alittleboy

@alittleboy 你考虑过使用roxygen2来创建帮助文件吗？ - Dason

如果您解决了问题，能否回答自己的问题（这样其他人就可以从示例中学习，并且该问题将从未回答的问题列表中删除）？ - David Robinson

Answer 1

在使用百分号 (%) 时，我曾经遇到过这个问题。我试图为置信区间参数编写文档。然后，我意识到我需要用反斜杠转义该符号以解决错误（就像在LaTeX中一样）。因此，我用 \% 替换了 %，这修复了错误。

- Jeromy Anglim

Answer 2

在.Rd文件中存在{ }不匹配的问题，这会导致出现问题。很难检测到，请确保在执行R CMD check pkg_name之前匹配好对应的大括号。

- alittleboy

Answer 3

现在有更多的人使用 roxygen2（幸运的是）支持markdown，因此可能会遇到这个错误信息。如果是从旧的LaTeX文件进行转换，则某些符合LaTeX规则的语法可能仍然隐藏在手动转换中。

将'word'转换为'word'解决了我的Rd解析错误（即，将前导反引号更改为常规引号）。

- wibeasley

---

我遇到了这个问题，因为我使用了反引号，并忘记在描述文件中添加Roxygen: list(markdown = TRUE)。 - moodymudskipper