2016-09-23 51 views
2

我在RStudio & devtools的帮助下为命名空间做了一个软件包,对于手册页描述为& Roxygen2。这工作得很好,我最近添加的帮助页也起作用了。我决定添加作者姓名,电子邮件和一些细节。最初由手动编辑手册页文件(BAD),然后编辑将R脚本Roxygen2部分&推动改变对RM文件,document()R github软件包w/devtools:警告未知宏' item'

但是:当我安装我的包

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)引起的,其他人都应该没问题?

在此先感谢。

+0

'\ item'只在一个有效逐项“环境”。你确定你的文档是\ item只出现在'\ itemize {\ item hi \ item bye}'或'\ enumerate {\ item hi \ item bye}'中吗? '\ value','\ description'和'\ examples'应该是'@ value','@ description'和'@ examples'。有关这方面的更多指导,请参阅'roxygen2'指南。 – Chrisss

+0

如何使用RStudio打开有问题的.Rd文件并预览它?如果您有以前的工作版本,您还可以比较两个版本的.Rd之间的差异。另一个疯狂的猜测是,如果你手动编辑了一些文件,可能会有编码/行结束的变化,你没有意识到。 – dracodoc

+1

它可能是'&'的行,如“用(例如)read.csv&Import”导入,虽然我不完全确定。我记得一些有问题的标点符号,尤其是'%'。改变'&'为'和'可能值得一试。 – Benjamin

回答

2

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

  1. 使用建立包项目在建面板&负载的工具。您可以构建,更新文档(您可能想要在设置Roxygen2时查看更多选项,有些默认情况下未打开),只需单击一次即可加载软件包。您遇到的错误应该在之前找到,而且您无需手动安装即可进行测试。

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

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

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

为了使这一答案更完整,这里有从@Benjamin有关Rd文件格式设置提示:

可能像线&“导入用(例如)read.csv &指定” 虽然我不完全确定。我记得一些标点符号是 有问题,特别是%。更改&并可能是值得一试

从@Thomas:

也可以拿出如果你有一只流浪{某处

+0

谢谢。任何其他有这个问题的人,还要注意@Thomas的注意事项,以防止杂乱的花括号 –