R带有devtools的github包:警告未知宏'\项目';
在RStudio和devtools的帮助下,我为手册页的namespace、DESCRIPTION和Roxygen2制作了一个包。这很好,我最近添加的帮助页面也很有效。我决定添加作者姓名、电子邮件和一些细节。首先手动编辑手册页文件(BAD),然后编辑R脚本Roxygen2部分,并使用R带有devtools的github包:警告未知宏'\项目';,r,github,documentation,package,devtools,R,Github,Documentation,Package,Devtools,在RStudio和devtools的帮助下,我为手册页的namespace、DESCRIPTION和Roxygen2制作了一个包。这很好,我最近添加的帮助页面也很有效。我决定添加作者姓名、电子邮件和一些细节。首先手动编辑手册页文件(BAD),然后编辑R脚本Roxygen2部分,并使用document() 但是:当我安装我的软件包时 devtools::install_github('SimonDedman/gbm.auto') 我收到以下警告: Warning: /tmp/RtmpNladba
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
参数,我没有改变它们,看起来很好,以前工作过。与值
/说明
/示例
参数相同,这些参数都是标准参数(但可能是下游问题,一旦上游问题得到解决,下游问题就会得到解决)
谁能想到这是什么原因吗?我的帮助页面现在都不可点击,即使有人会认为,不管一个脚本(gbm.valuemap.R)有什么问题,其他脚本应该没问题吧
提前感谢。您可以使用RStudio在多个方面帮助开发软件包:
.Rd
文档文件中的%
更改为\%
,或底层的roxygen注释,应可防止与%符号的使用相关的问题。这是由于使用了乳胶
来自@Thomas:
如果你在某个地方有一个流浪汉,也可以上来
对我来说,这是在我正在编写的库中的函数描述中使用
\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
}
我在
未知宏'\item'
中遇到了相同的错误,并通过从文件中删除重复的@author XXX
行解决了该错误。似乎重复的@{item}
参数不打算重复可能会引发该错误。\item
仅在逐项列出的“环境”中有效。您确定您的文档只显示在\item{\item hi\item bye}
或\enumerate{\item hi\item bye}中吗
?还有\value
,\description
和\examples
应该是@value
,@description
和@examples
。有关这方面的更多指导,请参阅roxygen2
指南。如何使用RStudio打开有问题的.Rd文件并预览它?如果您有以前的工作版本,请您还可以比较.Rd的两个版本之间的差异。另一种猜测是,如果您手动编辑某个文件,可能会有您未意识到的编码/行尾更改。可能是“使用(例如)read.csv导入并指定”等行中的&
虽然我不完全确定。我记得一些标点符号有问题,特别是%
。将&
更改为和可能值得一试。大家好。@chriss\items在\arguments{}中它是由roxygen2骨架自动创建的,&与一切正常工作时的方式相同。格式为例如#示例无(带有at符号,我无法在此处包含)在R脚本的Roxygen2位中,所以都是正确的。dracodoc是一个好主意-正如本杰明预测的那样,原来是%符号。干杯,我现在编辑它,希望能解决它。我得到这个错误,因为我在文档中有一个%符号。谢谢。其他有这个问题的人,也请注意@Thomas的注释,以防迷路的curly括号创建使用预览功能的提示!其他可能的问题可能是:使用方括号(例如,表示数字的间隔)或转义百分比(\%而不是%)。