带开发工具的R github软件包：警告未知宏'\ item'

Question

我在RStudio＆的帮助下制作了一个devtools用于命名空间的包，在手册页中创建了Description＆Roxygen2。这很好用，我最近添加的帮助页面也起作用。我决定添加作者姓名，电子邮件和一些详细信息。最初，通过手动编辑手册页文件（BAD），然后编辑R脚本Roxygen2零件并使用以下命令将更改推送到Rm文件中：document()

但是：当我安装我的软件包时

devtools::install_github('SimonDedman/gbm.auto')

我收到以下警告：

Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:35: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:37: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:39: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:41: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:43: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:45: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:47: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:49: unknown macro '\item'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:51: unexpected section header '\value'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:55: unexpected section header '\description'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:65: unexpected section header '\examples'
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:69: unexpected END_OF_INPUT '
'

这些项目只是简单的@param参数，我没有改变，看起来很好，以前也可以使用。同上的value/ description/ examples参数，这些都是标准的（但可能是下游的问题，一旦上游问题是固定的，这将得到解决）。

谁能想到这可能是什么原因？我的帮助页面现在都无法单击，即使一个人以为一个脚本（gbm.valuemap.R）遇到此问题，其他都应该可以吗？

提前致谢。

Answer 1

您可以使用 RStudio 在几个方面帮助包开发：

1. 在构建面板中使用构建和加载工具来打包项目。您可以构建、更新文档（您可能想查看更多关于 Roxygen2 的设置选项，有些是默认不开启的）、一键加载包。你遇到的错误应该早发现了，不需要手动安装测试。

2. 使用 .Rd 文件的预览功能

另一种方法是比较工作和非工作版本源文件、.Rd 文件以找出差异。

通常应避免直接编辑生成的文件。

为了使这个答案更完整，以下是@Benjamin 关于 Rd 文件格式的提示：

尽管我不完全确定，但它可能是“使用（例如）read.csv 导入并指定”之类的行中的 &。我记得有些标点符号有问题，尤其是 %。改变 & 可能值得一试

注意在文档文件或底层 roxygen 注释中更改%为，应该可以防止与使用 % 符号相关的问题。这是由于使用了 LaTeX。\%.Rd

来自@托马斯：

如果你有一个流浪的{某处，也可以出现

Answer 2

对我来说，这发生在我正在\n编写的库中的函数描述中（我正在描述反斜杠“n”转义序列的含义。我通过在函数.Rd文件中转义转义序列本身来修复它。例子：

错误/错误：

\description{
Blah blah and `\n` is an example of blah blah blah
}

固定/解决方案：

\description{
Blah blah and `\\n` is an example of blah blah blah
}

Answer 3

对我来说，问题是在文本中使用“%”符号。当我删除它或转义它（“\%”）时，它不再抛出错误。如果您在编辑器中打开 roxygen 生成的 .Rd 文件，它可以给您一个提示，对我来说，% 后面的文本颜色不同。