Question

我在RStudio＆amp; amp;的帮助下制作了一个包。 devtools用于命名空间，DESCRIPTION＆amp; Roxygen2为手册页。这很好用，我最近添加的帮助页也有效。我决定添加作者姓名，电子邮件和一些细节。最初通过手动编辑手册页文件（BAD）然后编辑R脚本Roxygen2 parts＆amp;使用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在几个方面帮助开发包：

使用build＆amp;在包项目的构建面板中加载工具。您可以构建，更新文档（您可能需要在设置Roxygen2时检查更多选项，有些默认情况下没有打开），只需单击一下即可加载包。您应该早些找到您遇到的错误，并且不需要手动安装进行测试。
使用.Rd文件的预览功能

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

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

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

它可能是＆amp;在＆＃34;导入中（例如）read.csv＆amp;指定＆＃34; 虽然我不完全确定。我记得有些标点符号有问题的，特别是％。变化与变化并且可能值得一试

N.B。将\%文档文件中的.Rd更改为_form.html.erb ............... <p> <h1 style="color:red;"> Register your vote </h1> <%= form_for @topic do |t| %> <%=t.label :"#{current_user.name}_vote".to_sym%> <%= t.text_field :"#{current_user.name}_vote".to_sym%> <%= t.submit "Submit Vote", class: "btn btn-primary btn-lg" %> </p> ..............或基础漫游评论可以防止与使用％符号相关的问题。这是由于使用了LaTeX。

来自@Thomas：

如果你有一个迷路{某处
，也会出现

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

我在unknown macro '\item'上遇到了相同的错误，并通过从文件中删除重复的@author XXX行来解决了该错误。似乎重复的@{item}参数不应该重复，可能会导致该错误。

带有devtools的R github软件包：警告未知的宏＆＃39; \ item＆＃39;

3 个答案: