r - 检查 R 包时出现意外的节标题“\examples”

Question

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

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

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

\example{
...
}

不幸的是，它无法通过包裹检查程序...在此先感谢您的帮助！

score 38 · Accepted Answer

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

score 5 · Accepted Answer

.Rd 文件中的 { } 不匹配会导致问题。很难检测到，请确保在执行 R CMD 检查 pkg_name 之前已匹配对。

score 3 · Accepted Answer

既然 roxygen2 （幸运地）支持 markdown ，这个错误消息可能会得到更多的点击。如果从旧的 LaTeX 样式文件转换，某些 LaTeX 合法语法可能仍会通过手动转换隐藏。

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

3 回答 3