R github 包 w/devtools : warning unknown macro '\item'

Question

我在 RStudio 和 devtools 的帮助下制作了一个包(用于命名空间)、DESCRIPTION 和 Roxygen2(用于手册页)。这工作得很好，我最近添加的帮助页面也工作正常。我决定添加作者姓名、电子邮件和一些详细信息。最初通过手动编辑手册页文件(BAD)，然后编辑 R 脚本 Roxygen2 部分并使用 document()

将更改推送到 Rm 文件

但是:当我安装我的包时

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 文件格式的提示:

It may be the & in lines like "Import with (e.g.) read.csv & specify" although I'm not entirely sure. I recall some of the punctuation being problematic, especially %. Changing & to and might be worth a shot

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

来自@Thomas:

Can also come up if you have a stray { somewhere