我有一个功能包;一个功能具有22个参数(包括...
)。我最近将一个参数从一个...
选项移到了一个完整参数,并注意到,即使在函数参数列表中以逻辑顺序描述该参数时,在roxygen2 @params项目列表中以相同顺序描述该参数时document()
,新项目...
位于底部项目的下方,其本身后面是另一个参数,我也已将其放在逻辑位置。
示例:脚本如下所示:
#' @param ParameterA does something
#' @param ParameterB does something else
#' @param ... optional extras
foo <- function(ParameterA, ParameterB, ...)
Rd和帮助文件如下所示:
Arguments
Parameter A does something
... optional extras
Parameter B does something else
我知道这很琐碎,但是有人知道如何解决吗?我删除了.Rd文件,document()
但无济于事。
屏幕快照的Imgur专辑(3张):http : //imgur.com/a/pUX4m
编辑:更多挖掘:我运行了构建并重新加载,检查并看到:
Documented arguments not in \usage in documentation object 'gbm.auto':‘tc’ ‘mapshape’.
Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
“RC”前最后一段在这里说@usage
不再需要因为roxygen2的V3自动生成此。但是,尽管过去有过工作,但是这对我不再有用。
找到了罪魁祸首:R
文件夹中有另一个脚本,其中具有相同的功能(本质上是主要功能的草稿/叉子,我正在尝试将其更改为该功能)。(我假设)document()
是从gbm.auto.R写入gbm.auto的Rd文件,然后从gbm.auto_binonly.R覆盖Rd文件,删除所有更改。对不起乡亲
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句